Proceso general de infopiezas.net
- La aseguradora crea una licitación de piezas y se abre el proceso de licitación. El proceso dura las horas laborables indicadas en la licitación.
- Los suplidores envían cotizaciones para cada licitación. Mientras el proceso de la licitación esté abierto
- Una vez cerrado el proceso de cotización la aseguradora revisa las cotizaciones y elige uno o varios suplidores para comprar las piezas.
- La aseguradora emite una o varias órdenes de compra a uno o más suplidores. Los suplidores reciben la orden de compra correspondiente.
- La aseguradora puede emitir una orden de servicio (mano de obra) al taller correspondiente.
- El suplidor envía las piezas al taller y las marca enviadas en el sistema.
- El taller recibe las piezas que envió el suplidor.
Documentación del API
El API utiliza el standard de OpenAPI Specification (OAS), por lo cual se pueden utilizar herramientas de este framework.
Para ver una documentación de todos los métodos del API, y probar las llamadas a los mismos se puede utilizar la ruta /swagger para visualizar una herramienta dinámica.
El enlace completo aparece en la pantalla principal de este site en la opción Documentación general. Para volver a la pantalla de inicio haga click aquí.
En esta pantalla puede visualizar en detalle los métodos disponibles en el API.
Si hace click en uno de los métodos, por ejemplo, el método GET de la entidad Quotes se puede ver un detalle de la llamada, incluyendo los parámetros a utilizar.
Por ejemplo, en este caso, se indica que el parámetro quoteId es requerido y debe ser enviando dentro de la ruta. También incluye un header de autenticación.
En el área de Example Value aparece un ejemplo del objeto que devuelve el método. Al hacer click sobre la palabra Model que aparece a la izquierda de Example Value se puede ver la documentación del objeto completo y cada uno de sus campos y colecciones.
Llamadas de ejemplo
Se pueden ejecutar cada uno de los métodos en esta pantalla. Debe autenticarse antes de poder ejecutar los métodos. Para autenticarse, debe hacer click sobre el signo de admiración rojo que aparece en el área del método a ejecutar.
Al hacer click sobre este ícono, aparece una pantalla de autenticación como la que se muestra a continuación. Debe indicar en username el email del usuario a utilizar, y en password la clave del usuario y presionar el botón Authorize. Si el email/clave son correctos, la pantalla refrescará el signo de admiración rojo desaparecerá y será reemplazado por un signo de información color azul. Esto indica que ya está autenticado y puede utilizar las opciones de Try it out que aparece en cada uno de los métodos para hacer llamadas de ejemplo al API.
Descripción del Api
El API de infopiezas.net es un REST API que recibe y envía la información en formato json.
Para hacer las llamadas a los métodos del API, el primer paso es autenticar el usuario para obtener el token de acceso requerido para cada llamada.
Para probar el acceso al API, se puede utilizar una herramienta como Postman para hacer llamadas de ejemplo al API. Durante este documento, presentaremos algunos ejemplos utilizando esta herramienta.
Autenticación
El API utiliza el framework OAuth2 para la autenticación. Todas las llamadas al API deben estar autenticadas con un token que se obtiene haciendo una llamada POST al endpoint /token enviando los siguientes datos:
| Parámetro | Descripción |
|---|---|
| username | login del usuario en infopiezas.net (email) |
| password | clave del usuario en infopiezas.net |
| grant_type | password |
NOTA: Este es el primer paso para hacer llamadas a los diferentes métodos del API, ya que todos los métodos requieren el token de autenticación.
Si la autenticación no es exitosa, el api devuelve un status code 400 con una respuesta similar a la que aparece a continuación:
xxxxxxxxxx{ "error": "invalid_grant", "error_description": "The user name or password is incorrect."}Si la autenticación sí es exitosa el api devuelve un status code 200 con una respuesta similar a la que aparece a continuación:
xxxxxxxxxx{ "access_token": "zZWoCzjdw28Sxm3GtFAZ5bhazgs72bzyjcnfpE14KC2tczBZnKFrvo6mOj8JPahR_nkQ2OtfE7w1p_B5ibYrUQYmlZYgq73UOL1yhabWW_V5Hlu7ZhyKyDtccYkp1oHozA_fpN-S4YUCpTpOlbZ43vuKsqEsFBVDiyk8R0nK8xa7fPbXExDnYl7JLFRNcIORTnnCgWGYTN4T1zbUnuv04YGhLtWQJEemCKrQfmjl365zVCLosNAKGrc7x-M_2xrIpLZRVwyKyYFws5INCkVK9_f0mCJAkll2__owVnmBy5wGY984RBBgaPe1eIqGa6NaYCTCZjGJV-6z9L09T5eBQb74_aiBFxXSiGAu0o15aMIaRY58H2BPOS6darsU2eY6QXnXDHp0x4OwKb8sT_tmF0BCEiGWdrhcTIr9SEz55W2UQp60A5ebA36IhtqHaBuo", "token_type": "bearer", "expires_in": 1209599}A continuación, una captura de Postman utilizado para llamar el método de autenticación del API.
Se debe tomar el contenido del campo access_token para enviarlo en el header de cada una de las llamadas al API. Debe enviarse como el header the HTTP Authorization como parámetro, y la palabra Bearer seguida del access_token obtenido en el paso de autenticación.
A continuación, una captura en Postman haciendo una llamada al método para obtener un listado de la tabla de ciudades de la aplicación.
Observaciones generales
Formato de fechas
Los campos que indican fechas e incluyen la palabra UTC en el nombre del campo son fechas dadas en UTC. Por ejemplo, el campo CreatedOnUtc de la licitación está representado en UTC. Sin embargo, el campo CollisionDate no tiene la palabra UTC en el nombre del campo, por lo cual está expresado en fecha local. Los datos de fecha que son digitados por el usuario, por lo general son expresados en fecha local, y los campos propios del sistema, en UTC. Para llevar de UTC a fecha local se deben restar 4 horas.