Agregar o quitar monedas a un conductor

[ POST ]

Esta ruta permite agregar o quitar monedas a un conductor.

https://sync.airbagtech.io/coins/modify

Headers

Content-Type	Authorization
application/json	apikey {{API_KEY}}

Body

Se debe enviar un objeto JSON (body) con los siguientes atributos:

{
  "driverId": "string",
  "value": "number",
  "description": "string"
}

Campos

Nombre	Tipo	Requerido	Descripción
driverId	string	Sí	Id del conductor. Acepta el ID que tu empresa usó al crearlo o el airbagId.
value	number	Sí	Cantidad de monedas a agregar o quitar
description	string	Sí	Descripción de la modificación

Valores de los datos

Nombre	Descripción
value	Debe ser un número entero Puede ser número positivo eg. 20 (para agregar monedas) Puede ser número negativo eg. -20 (para quitar monedas) El valor no debe sobre pasar +/- 2000 El saldo del conductor no puede quedar por debajo de 0

Ejemplo

curl --location --request POST 'https://sync.airbagtech.io/coins/modify' \
--header 'Content-Type: application/json' \
--header 'Authorization: apikey {{API_KEY}}' \
--data '{
    "driverId": "5f7b3b3b1c9d4400008d3b3b",
    "value": 20,
    "description": "Agregando monedas"
}'

Respuesta

201 - Created

{
    "status": true,
    "transactionId": "xJcvkFGYXVqP22qlSYj5",
    "oldCoins": 10,
    "newCoins": 30
}

Campos

Nombre	Descripción
transactionId	Id de la transacción
oldCoins	Cantidad de monedas antes de la modificación
newCoins	Cantidad de monedas después de la modificación
status	Estado de la petición

401 - Unauthorized

La API key no existe o está inactiva. Ver Autenticación › Errores de autenticación.

{
    "status": false,
    "error": "You are not authorized to perform this action",
    "errorId": "-1"
}

400 - Bad Request

{
    "status": false,
    "message": "Error: Monedas insuficientes para realizar esta operación",
    "errorId": "sentry_error_id_123"
}

campos

Nombre	Descripción
message	Mensaje de error
status	Estado de la petición
errorId	Identificador del error para soporte

Mensajes de error (400)

Mensaje	Causa
Error: La cantidad de monedas debe ser un valor entero	value no es un número entero.
Error: La cantidad de monedas debe ser igual o menor a 2000	El valor absoluto de value es mayor a 2000.
Error: Conductor no encontrado	El driverId no corresponde a ningún conductor de tu empresa.
Error: Monedas insuficientes para realizar esta operación	El saldo del conductor quedaría por debajo de 0.
Coins can't be blank, Driver id can't be blank, Description can't be blank	Falta un campo obligatorio. Si faltan varios, los mensajes llegan separados por comas. El mensaje nombra Coins aunque el campo enviado es value.
Coins must be of type number	value no es un número.