Interface da API

O Interface da API é uma representação da API do ExoClick concebida para detalhar os pedidos disponíveis, os respetivos parâmetros e as respostas esperadas. Pode vê-la no Painel de Administração.

Todos os pedidos da API estão listados sob o respetivo grupo.

Para aceder a pedidos restritos da API, tem de existir um Token de Sessão definido. Para definir um token, tem de ter uma conta válida com o nome de utilizador e a palavra-passe necessários ou um token de API. Clique no Iniciar sessão botão no canto superior direito do ecrã e introduza o seu nome de utilizador e palavra-passe ou forneça um token de API. Depois de clicar no Iniciar sessão botão, será feito um pedido de início de sessão à API para recuperar um token de Sessão válido. Esse token será então utilizado para validar todos os pedidos da API que pretenda fazer nessa sessão.

Para fazer um pedido à API, clique num grupo. O grupo será expandido para listar os pedidos disponíveis. Clique novamente no pedido pretendido. Um painel será expandido, detalhando as informações do pedido.

• O Corpo da resposta, se existir, será apresentado primeiro juntamente com a resposta Tipo de conteúdo.
• O Parâmetros do pedido, obrigatórios e/ou opcionais, são detalhados de seguida, juntamente com o pedido Tipo de conteúdo, se necessário.
• Esperadas Mensagens de resposta são então listadas.
• Para fazer o pedido, preencha os parâmetros obrigatórios. Se o corpo do pedido estiver detalhado, clicar no corpo na janela de Modelo irá pré-preencher a janela de parâmetros com o corpo.
• Assim que todos os parâmetros obrigatórios tiverem sido definidos, clicar no Experimentar botão executará o pedido.
• Abaixo do botão aparecerão quatro painéis:

  • O primeiro apresenta o URL do pedido.
  • O segundo detalha o Corpo da resposta.
  • O terceiro detalha o Código da resposta.
  • O quarto detalha os Cabeçalhos da resposta.