Regras gerais

  • A API REST está disponível abaixo do URL de base:

/public/external/api

  • Todos os pedidos têm de ser enviados através de POST.
  • A API REST só suporta pedidos via HTTPS.
  • Os pedidos devem conter os seguintes cabeçalhos:
Edita

Nome do cabeçalho



Valor do cabeçalho



Descrição



Tipo de conteúdo



aplicação/json



fixa



autenticação



123…xyz



Chave da API no separador “Acesso à API”



assinatura



Assinatura codificada em base64



Assinatura do payload gerado com o


chave privada do separador “Acesso à API


  • O corpo do pedido deve ser um objeto codificado em json que deve conter os seguintes valores:
Edita

Campo



Campo Exemplo Valor



Descrição



API



v2/dispositivo/lista de dispositivos



Nome da API



tempo



1529662725



Carimbo de data/hora Unix (UTC) da máquina cliente.


A diferença de tempo máxima permitida


entre o cliente e o servidor é de 30


minutos.


  • Em caso de sucesso, a API devolve os dados solicitados (ver as consultas abaixo) e um código de estado HTTP 200.
  • Se ocorrer um erro, o código de estado HTTP será entre 4xx e 5xx, dependendo do erro, e o objeto de resposta conterá uma matriz com a chave “errors”, que contém uma lista de mensagens de erro legíveis por humanos.
  • Se não existirem dados correspondentes para um dispositivo, é devolvido um conjunto vazio.
  • Se um ID de dispositivo não existir, os dados de retorno serão nulos.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.