Appearance
Autenticación
La autenticación permite identificar a la empresa y la aplicación que accede al sistema. Al autenticarse, el sistema genera un token para acceder a los recursos.
Generar token
Forma recomendada
La forma más sencilla y recomendada de obtener un token es desde la aplicación de UpConta, en la sección de Configuración > Empresa:
- Pruebas: https://app-test.upconta.com/configurations/business
- Producción: https://app.upconta.com/configurations/business
También puedes generar un token mediante la API:
POST
/v3/auth/userTEST
https://api-test.upconta.com/v3/auth/userPROD
https://api.upconta.com/v3/auth/userCampos de petición
| Nombre | Descripción |
|---|---|
ruc | Identificación de la empresa |
username | Nombre de usuario o aplicación |
password | Contraseña de acceso |
Ejemplo de cuerpo de petición
json
{
"ruc": "1234567890001",
"username": "usuario_ejemplo",
"password": "********"
}Ejemplo de respuesta
json
{
"name": "Nombre Empresa",
"user": "Nombre Usuario",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoiNjVfIiwiYnVzaW5lc3MiOiI1Zl8iLCJ0eXBlIjowLCJkYXRlIjoxNzgwMDg5MDgzNjMwLCJlbmREYXRlIjoxNzgwNzIxOTk5OTk5fQ.ejemplo_token"
}Ejemplos de errores
json
HTTP/1.1 400 Bad Request
{
"code": "BadRequest",
"message": "No se proporcionó las credenciales"
}json
HTTP/1.1 404 Not Found
{
"code": "NotFound",
"message": "No se encontró esa empresa"
}json
HTTP/1.1 401 Invalid Credentials
{
"code": "InvalidCredentials",
"message": "Usuario o contraseña incorrectos"
}Verificar token
GET
/v3/auth/userTEST
https://api-test.upconta.com/v3/auth/userPROD
https://api.upconta.com/v3/auth/userVerifica si el token es válido y retorna la información de la sesión.
Ejemplo de respuesta
json
{
"_id": "60...",
"ruc": "1234567890001",
"business": "Nombre Empresa",
"user": "Nombre Usuario",
"modules": [
{
"key": "administrative",
"label": "Administrativo",
"icon": "receipt",
"submodules": [
{
"label": "Comprobantes",
"items": [
{ "key": "invoices", "label": "Facturación electrónica" },
{ "key": "credit-notes", "label": "Notas de crédito" }
]
}
],
"operationDate": "2024-01-01T00:00:00.000Z"
}
],
"configs": {
"useTestEnviroment": false,
"establishments": []
},
"sessionStartDate": "2024-01-01T00:00:00.000Z",
"sessionEndDate": "2024-01-31T23:59:59.999Z"
}| Campo | Descripción |
|---|---|
ruc | RUC de la empresa |
business | Nombre de la empresa |
configs | Configuraciones de la empresa |
configs.useTestEnviroment | true si se usa el entorno de pruebas |
user | Nombre del usuario |
sessionStartDate | Fecha de inicio de sesión |
sessionEndDate | Fecha de fin de sesión |
Ejemplos de errores
json
HTTP/1.1 400 Bad Request
{
"code": "BadRequest",
"message": "No se proporcionó el token"
}json
HTTP/1.1 400 Bad Request
{
"code": "BadRequest",
"message": "Error al decodificar el token"
}