Login

Descubre como acceder con tu usuario y generar peticiones a nuestra API.

Inicio de sesión

Para realizar la petición y obtener el inicio de sesión debes tener muy claro tu nombre de usuario y tu contraseña. Dentro del post que verás a continuación se muestran campos para realizar tu petición pero es importante observar cuales son obligatorios.

Peticion para inicio de sesion

POST https://sandbox.apagar.co/api/v1/auth/login

Request Body

Name	Type	Description
data*	Object	Objeto principal
User*	Object	Objeto de datos del usuario
username*	String	Nombre de usuario
password*	String	Clave del usuario
otp	String	Código OTP

200: OK Inicio de Sesión creada.

Request

{
    "data": {
        "User": {
            "username": "304*******",
            "password": "*******"
        }
    },
    "_channel": "web",
    "_deviceKey": "laptop"
}

Response

{
    "data": {
        "User": {
            "id": 183,
            "rol": 5,
            "token": "1655849***904JDJiJDEwJHUzSkFoQ0kyRGtVZFV0NmtzU1VTZ2VqNThsNVNpaVFzZmgvTHRiVFh5eGlYRjZJRmpyZUl1",
            "name": "test api 1",
            "docNumbre": "105***8962",
            "cellphone": "31052***2524",
            "email": "al****@email.com",
            "logo": null,
            "missingPin": 1,
            "env": "Sand",
            "balance": 64167,
            "Privileges": [
                "profile.password.change",
                "reports.sales",
                "list.withdraw",
                "profile.sessions.close",
                "profile.edit",
                "upload.logo",
                "upload.data",
                "dashboard.view",
                "customers.list",
                "transaction.set.confirm",
                "users.create",
                "users.edit",
                "users.list",
                "users.delete",
                "transaction.query",
                "list.account",
                "remove.account",
                "add.account",
                "generate.resource",
                "customers.create",
                "customers.delete",
                "customers.edit",
                "reports.withdraw",
                "customers.transaction.list",
                "logout",
                "sessions.list",
                "profile.close.session",
                "generate.qr.mfa",
                "verify.mfa",
                "verify.pin",
                "forward.pin",
                "dashboard.list.transactions.last",
                "report.generate",
                "report.list",
                "report.build",
                "user.get.me",
                "user.switch.env",
                "user.get.attributes"
            ]
        }
    },
    "signature": "f3f****1c3f231910a869d1397b62ebb0f3f9092",
    "date": 16***49899991,
    "status": 200,
    "message": "Successful"
}

400: Bad Request Credenciales Invalidas

Cerrar sesión

Para realizar una petición exitosa del logout, es importante recordar que en el Bearer Token se debe de colocar el token obtenido como respuesta en el inicio de sesión..

Servicio para hacer logout en la plataforma

POST https://sandbox.apagar.co/api/v1/auth/logout

En este servicio solo enviamos la petición con un objeto vacio.

Request Body

Name	Type	Description
data*	Object	Datos principales

200 Logout exitoso

Request

{
  "data": null,
  "signature": "4e589c3***f19b21dbdddb4d036205748f7626b0",
  "date": 1***365028580,
  "status": 200,
  "message": "Successful"
}

401: Unauthorized Logout fallido

Cambiar contraseña

En este punto para realizar la petición de cambio de contraseña de manera correcta, en el Bearer Token se deberá colocar el token de la respuesta del inicio de sesión.

Servicio para hacer cambio de contraseña

POST https://sandbox.apagar.co/api/v1/auth/logout

Request Body

Name	Type	Description
data*	Object	Datos principales
user*	Object	Datos de usuario
currentPassword*	string	Contraseña actual del usuario
newPassword*	string	Nueva Contraseña
confirmPassword*	string	Confirmación Nueva contraseña

200 Contraseña Modificada

Request

{
  "data": null,
  "signature": "a02f71f1bf9668a9ef415c591196a770216945c7",
  "date": 161828279****,
  "status": 200,
  "message": "Contraseña actualizada"
}

401: Unauthorized Sesión terminada