Saltar al contenido principal

Introducción

Puedes integrarte como operadora para que desde velocity se puedan realizar cotizaciones, creación de envíos, actualización de estados de envíos, entre otros.

Para esto se deben implementar los siguientes endpoints:

Estos endpoints deben ser implementados en tu API para que velocity pueda interactuar con tu operadora. una vez registrados en velocity, desde velocity se llamarán a estos endpoints para realizar las operaciones mencionadas.

Autenticación​

Para la seguridad de las operaciones, velocity enviará un usuario y un token usando el método de autenticación Basic Auth.

Estos datos deben ser únicos por cada cuenta conectada. Por ejemplo, supongamos que eres la operadora Operadora A y varios clientes tuyos quieren conectarse a velocity, para cada cliente debes generar un usuario y un token únicos. Estos clientes podran conectarse a tu operadora desde velocity usando estos datos. Ver Conectar para más información.

De esta forma cuando un cliente va realizar una cotización, creación de envío, etc, velocity enviará el usuario y token correspondiente a ese cliente y puedas gestionar correctamente la operación.

Cambio de estado y evidencias​

Cuando se actualiza el estado de un envío, puedes notificar a velocity enviando una petición al endpoint Webhook

Ambientes​

Estructura general de los endpoints​

Request​

Para cualquier endpoint, Velocity enviara una petición POST en formato JSON con los siguientes headers:

  • Authorization: Basic Auth
  • Content-Type: application/json
  • Accept: application/json

Response​

La respuesta de tu API debes responder con un código de estado HTTP 200 y un cuerpo en formato JSON con la siguiente estructura:

{
  // Datos de respuesta, puede variar segun el endpoint
  "data": {},

  // Mensaje de error, si existe
  // si la operación fue exitosa, no se debe enviar este campo
  // si hubo un error, se debe enviar este campo con el mensaje de error
  "error": "string" 
}