Interface API
The API Interface is a representation of the ExoClick API designed to detail available requests, their associated parameters and their expected responses. You can view it from the Admin Panel.
Todos os pedidos de API são listados no seu grupo associado.
Para aceder a pedidos de API restritos, é necessário definir um Token de sessão. Para definir um token, é necessário ter uma conta válida com o nome de utilizador e a palavra-passe necessários ou um token de API. Clique no botão Login 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 botão Login, será efectuado um pedido de início de sessão à API para obter um token de sessão válido. Este token será então utilizado para validar todos os pedidos de API que pretenda efetuar nessa sessão.
Para efetuar um pedido à API, clique num grupo. O grupo expandir-se-á para listar os pedidos disponíveis. Clique novamente no pedido pretendido. Um painel expandir-se-á, apresentando os detalhes do pedido.
O Corpo da resposta, se existir, será apresentado em primeiro lugar juntamente com o Content-type da resposta.
Os Parâmetros do pedido, obrigatórios e/ou facultativos, são descritos em seguida, juntamente com o Tipo de conteúdo do pedido, se necessário.
As Mensagens de resposta esperadas são então listadas.
Para efetuar o pedido, preencha os parâmetros necessários. Se o corpo do pedido for detalhado, ao clicar no corpo na janela Modelo, a janela de parâmetros será previamente preenchida com o corpo.
Quando todos os parâmetros necessários tiverem sido definidos, clicar no botão Tentar executará o pedido.
Aparecerão quatro painéis por baixo do botão:
- O primeiro apresenta o URL do pedido completo.
- O segundo detalha o Corpo da resposta.
- O terceiro pormenoriza o Código de resposta.
- O quarto detalha os Cabeçalhos da resposta.