Agenda una demo
DocumentaciónAPI reference
Menú: API reference

Cloud API

Listar terminales

Devuelve los terminales de un local. Sirve también para comprobar que las credenciales son válidas.

GET/terminals

Devuelve los terminales del local identificado por venue-api-key, y solo los de ese local.

Cabeceras

Cabecera Valor Obligatoria
Authorization Bearer <clientSecret> Sí
venue-api-key La clave de tu local Sí

Parámetros de consulta

Parámetro Tipo Obligatorio Descripción
page number No Página que quieres obtener, empezando en 1. Por defecto, 1.
limit number No Terminales por página. Por defecto, 30.

Respuesta

Las credenciales son válidas. data contiene los terminales del local.

JSON
{
  "data": [
    {
      "terminalId": "665f1c2e8b3a4d0012ab34cd",
      "name": "Barra",
      "model": "A920"
    },
    {
      "terminalId": "665f1c2e8b3a4d0012ab34ce",
      "name": "Terraza",
      "model": "S1F2"
    }
  ],
  "page": 1,
  "limit": 30,
  "totalCount": 2,
  "totalPages": 1
}
Campo Tipo Descripción
data[].terminalId string Identificador del terminal. Úsalo como :terminalId en el resto de la Cloud API.
data[].name string Nombre que el local ha dado al terminal.
data[].model string Modelo del terminal.
page number Página actual.
limit number Terminales por página.
totalCount number Total de terminales del local.
totalPages number Total de páginas disponibles.

Las credenciales no son válidas: el token de Authorization es incorrecto o está desactivado, falta venue-api-key o no es válida, o el local no está vinculado a tu integración.

JSON
{
  "code": 401,
  "message": "Not authorized"
}