Comienzo Rápido

A continuación podrás visualizar los links de nuestro ambiente de pruebas y el Endpoint de nuestra API

Sandbox URL: https://sandbox.apagar.co/api/v1/

API Endpoint: https://api.apagar.co/api/v1/

Contact: [e-mail]

Schemes: https

Version: 1.0.0

Http Status Codes

Code	Description
200	Operación exitosa	✅
400	Errores ocasionados por el usuario	🧑
401	Error de autenticación	❓
500	Error del servicio	❌

Nota: Los mensajes anteriores son los códigos de respuesta que obtendrás al realizar cualquier petición a nuestra API

Authentication

Las solicitudes API estan autenticadas utilizando API keys. Cualquier solicitud que no incluya un API Key retornará un error .

Bearer Token (API key Authentication)

Token que se envía en el header bajo el campo Authorization.

Name: Authorization

In: Header

Type: ApiKey

Nota: Debes recordar que el Token que se ingresa en las peticiones es uno de los datos que te fueron otorgados al momento de la creación de tu usuario.

Realiza tu primera solicitud

Para realizar tu primera solicitud de autenticación , envíala al siguiente endpoint , con ésta podrá crear un nuevo usuario . A continuación podrás observar los parámetros del Body y las posibles respuestas.

Crear Cuenta.

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

Crear un nuevo usuario

Request Body

Name	Type	Description
registerType*	string	El tipo de registro
Password*	string	Contraseña
verify password*	string	Confirmación de contraseña
email*	string	correo electrónico
cellphone*	String	Numero Celular
City*	Object	Ciudad del cliente
id*	int	Id de la ciudad
User*	Object	Datos del usuario
Data*	Object	Datos principales
name*	string	Nombre del usuario
referred*	int	Id Usuario Referido
docType*	string	Tipo de documento identidad
docNumber*	string	Numero doc identidad
State*	Object	Depto del cliente
id	int	id del tipo de comercio
CommerceType	object	Especificar tipo de comercio
id*	int	id del departamento

200 Usuario creado

Request

{
    "data": {
        "User": {
            "registerType": "2",
            "password": "passD123456",
            "verifyPassword": "paD123456",
            "email": "a.ga***@****.com",
            "cellphone": "3105*****",
            "docType": "CC",
            "docNumber": "1088*******",
            "name": "Alejandro gaviria",
            "City": {
                "id": 34*
            },
            "State": {
                "id": 10*
            },
            "CommerceType": {
                "id": 1
            } 
        }
    },
    "_channel": "web",
    "_deviceKey": "laptop"
}

Response

{
    "data": {
        "User": {
            "name": "UNombre suario",
            "rol": "5",
            "docNumbre": "1053******",
            "cellphone": "310529****",
            "email": "ale***@gmail.com",
            "logo": null,
            "token": "1654176294****JDJiJDEwJEVxWldTUzZiOS9aZ2EuWVZoTHFTNy5OLngwUXN5amlFNXhhVFoyZi5EdE5nSmtYMVA0cm91",
            "missingPin": 1,
            "env": "Sand",
            "balance": 15000,
            "Privileges": [
                "profile.password.change",
                "reports.sales",
            ]
        }
    },
    "signature": "15909e****c1a995007babfce381b45de22bf64c",
    "date": 1654176294***,
    "status": 200,
    "message": "Usuario creado"
}

401 Permiso Denegado

Response

{ 
 "signature": "d***065fe3e773ac700f0d1ec72962acbc92fcc3",
 "path": "/switch/env", 
 "date": 1652886507****,
 "status": 401, 
 "errorCode": "auth.notPermission", 
 "message": "Sin permisos" 
}

También podrás llamar este método vía curl:

curl

curl --location --request POST 'https://sandbox.apagar.co/api/v1/auth/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "User": {
                }
            }
        }