Acciones al dispositivo

Enviar acción al dispositivo

POST /cloud-terminals/actions

Envía una acción a un terminal en la nube (dispositivo virtual). El servicio valida el ownership según el tipo de usuario (cliente o comercio), convierte el request en un evento de dominio y devuelve el request_id generado.

Acciones disponibles: RESTART, UPDATE_PARAMETERS.

El alcance de la acción depende de los identificadores que envíes en el body y de las credenciales del usuario:

  • Solo customer_id: la acción se aplica a todas las terminales bajo ese cliente.
  • customer_id + merchant_id: la acción se aplica a todas las terminales bajo ese comercio.
  • customer_id + terminal_id: la acción se aplica a esa terminal en específico.
  • customer_id + merchant_id + terminal_id: se prioriza el alcance por terminal; la acción se aplica a la terminal indicada por terminal_id.

En todos los casos, el acceso permitido depende de las credenciales del usuario que realiza la llamada.

Encabezados

Authorization: Bearer {access_token}
Content-Type: application/json

Body (JSON)

ParámetrosDescripción
customer_id
  • string
  • Identificador del cliente al que pertenece el terminal o las terminales
merchant_id
  • (opcional)
  • string
  • Identificador del comercio. Si se envía junto con customer_id, la acción aplica a todas las terminales del comercio
terminal_id
  • (opcional)
  • string
  • Identificador del terminal. Si se envía junto con customer_id, la acción aplica solo a esa terminal. Si se envían los tres (customer_id, merchant_id, terminal_id), se prioriza el alcance por terminal_id
action
  • string
  • Acción a ejecutar: RESTART o UPDATE_PARAMETERS
  • [RESTART,UPDATE_PARAMETERS]
curl --location --request POST 'https://api.menta.global/api/v1/cloud-terminals/actions' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "customer_id": "1176a88f-b436-4068-8189-5bfb19bfc3a2",
    "merchant_id": "5f520602-38f8-4067-a8b1-fe363f8b481d",
    "terminal_id": "42cc723b-017d-4ecf-ab10-05f20bafa4da",
    "action": "RESTART"
  }'

201: Created

{
  "terminal_id": "42cc723b-017d-4ecf-ab10-05f20bafa4da",
  "merchant_id": "5f520602-38f8-4067-a8b1-fe363f8b481d",
  "customer_id": "1176a88f-b436-4068-8189-5bfb19bfc3a2",
  "request_id": "54cedea2-a74e-47b6-bc7d-1a2495b8a365",
  "data": {
    "flow": "RESTART"
  }
}