API REST INTEGRACIÓN 1.0.0 - LIVE
La API Defontana está organizada en torno a REST. Nuestra API tiene URLs predecibles orientadas a los recursos, acepta cuerpos de solicitud codificados por formulario, devuelve respuestas codificadas por JSON y utiliza códigos de respuesta HTTP, autenticación y verbos estándar.
Puede usar la API Defontana en modo de prueba, que no afecta sus datos productivos ni interactúa con las redes bancarias u otro subsistema funcional. La URL API que usa para ingresar peticiones determinará si la solicitud es en modo en vivo o en modo de prueba.
Las operaciones ofrecidas por el sistema están separadas en módulos. Cada módulo de la API agrupa métodos para poder realizar operaciones dentro de un módulo de ERP. Los módulos que actualmente se encuentran desarrollados son los siguientes:
AUTH
ACCOUNTING
SALE
INVENTORY
PURCHASE
PURCHASEORDER
DISPATCH
ORDER
PRICING
Auth: agrupa métodos para obtener tokens de acceso. Para poder utilizar los métodos de los demás módulos es obligatorio obtener previamente un token mediante el cual el usuario valida que posee una sesión vigente en el sistema. Cada token obtenido invalida inmediatamente a todos los que hayan sido obtenidos previamente para el mismo usuario. Debido a esto, si se establece un proceso de ejecuciones paralelas en la API (por ejemplo, ingresar varias ventas al mismo tiempo), se debe establecer desde el lado del cliente un mecanismo de centralización de tokens para evitar invalidaciones.
Accounting: agrupa métodos para administrar la contabilidad de las empresas en el ERP.
Sale: agrupa métodos para administrar las ventas, artículos, clientes, etc. de las empresas en el ERP.
Inventory: agrupa métodos para administrar los movimientos de Inventario de las empresas en el ERP.
Purchase: agrupa métodos para administrar los movimientos de compras de las empresas en el ERP.
Purchaseorder: agrupa métodos para administrar las ordenes de compra de las empresas en el ERP.
Dispatch: agrupa métodos para administrar los despachos de las empresas en el ERP.
Order: agrupa métodos para administrar los pedidos de las empresas en el ERP.
Pricing: (pendiente)
Para poder apreciar un listado de los métodos ofrecidos por la API, se recomienda acceder a la documentación swagger de la misma, a través del siguiente enlace:
https://replapi.defontana.com/swagger
En la interfaz disponible en el enlace podemos ver todos los métodos disponibles, junto a sus datos de entrada y de retorno. También podemos simular las llamadas de cada método para realizar pruebas y aprender cómo funciona cada uno.
Contactos
Equipo Comercial | ||
|---|---|---|
Nombre y Apellido | Opciones | Detalles |
Lukas Díaz | ||
Equipo Ingeniería | ||
|---|---|---|
Nombre y Apellido | Opciones | Detalles |
Luis Lopez | ||
Ignacio Olivares | ||
Luis Muñoz | ||
Sebastián Morgado | ||
Métodos
A continuación se detallan los métodos disponibles en la API Defontana, pero antes un pequeño recordatorio:
HTTP | CRUD | OBSERVACIÓN |
|---|---|---|
GET | Lectura | disponible |
POST | Creación | disponible |
PUT | Actualización/Reemplazo | no disponible |
PATCH | Actualización/Reemplazo Parcial | no disponible |
DELETE | Eliminación | no disponible |
AUTH
Obtiene el token de autenticación de un usuario en particular, mediante las “credenciales tradicionales” de acceso al sistema.
Ambientes
Ámbito | URL |
|---|---|
Pruebas | |
Productivo |
Verbo HTTP: GET
Parámetros
Campo | Descripción | Requerido |
|---|---|---|
Client | Identificador del cliente | Si |
Company | Identificador de la empresa | Si |
User | Identificador del usuario | Si |
Password | Contraseña del usuario | Si |
De retorno, en caso de haber ingresado los datos de acceso en forma correcta, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”.
Respuesta
De retorno, en caso de haber ingresado los datos de acceso en forma correcta, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”
{
"success": true,
"message": null,
"access_token": "eyJ0eXAiOiJLCJh1NiJ9.ey...iZiDAwMzAX0.TR39EE6gtrk",
"expires_in": 378604799,
"token_type": "bearer"
}Respuesta
De retorno en caso de haber ingresado los datos de acceso en forma incorrecta, nos aparecerá un mensaje similar al siguiente. El mensaje de error vendrá en el campo “message“ como “Login failed“
{
"success": false,
"message": "Login failed"
"access_token": null,
"expires_in": 0,
"token_type": null,
}Obtiene el token de autenticación de un usuario en particular, mediante las credenciales de acceso al sistema a través de correo y contraseña.
Ambientes
Ámbito | URL |
|---|---|
Pruebas | |
Producción |
Verbo HTTP: GET
Parámetros
Campo | Descripción | Requerido |
|---|---|---|
Email de acceso | Sí | |
Password | Contraseña del email | Sí |
Client | Campo para indicar el id de cliente con el cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de un cliente en el ERP) | No |
Company | Campo para indicar el id de empresa con la cual se requiere iniciar sesión (solo requerido si el correo está asociado a más de una empresa) | No |
User | Campo para indicar el usuario con el cual se requiere iniciar sesión (solo requerido si el correo está asociado a clientes de distintos servicios) | No |
De retorno, en caso de haber ingresado los datos de acceso en forma correcta y no tener más de una empresa y/o usuarios asociados al correo, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”.
Respuesta
{
"success": true,
"message": null,
"jumpUsers": [
{
"client": "empresas defontana",
"company": "dfchile",
"user": "gpuellestorres",
"service": "international"
} ],
"authResult":
{
"success": true,
"message": null,
"access_token": "eyJ0eXAKV1J9.eyJuWJBRD...jMjYy0fQ.pi3hW7cPBs",
"expires_in": 378604799,
"token_type": "bearer"
}
}Se puede dar el caso de que nos llegue una respuesta similar a lo siguiente:
{
"success": true,
"message": "Debe indicar un cliente/empresa/usuario a utilizar",
"jumpUsers": [
{
"client": "client1",
"company": "company1",
"user": "user1",
"service": "international"
},
{
"client": "client1",
"company": "company2",
"user": "user2",
"service": "international"
},
{
"client": "client2",
"company": "company2",
"user": "user1",
"service": "pyme"
}
]
}En este tipo de casos debemos ingresar un id de cliente, empresa y/o usuario, para indicar con cuáles deseamos obtener un token. Para el ejemplo anterior, bastaría con indicar el “client2” de id de cliente (ya que no tenemos más de una empresa o usuario asociados a aquel cliente) y el método nos entregaría un token de acceso para la combinación [client2, company2, user1].