Visão geral da documentação da API 3.1 (administradores)
Natalya Yefimenko avatar
Escrito por Natalya Yefimenko
Atualizado há mais de uma semana

Documentação da API

A documentação da API do Affise permite que você trabalhe com os painéis Admin e Afiliado via API. A documentação fornece todos os dados necessários para fazer solicitações corretas e obter os dados de volta.

Há métodos para os usuários do painel de administração, para os usuários do painel de afiliados (seus afiliados) e métodos comuns.

Os métodos são agrupados de acordo com os objetivos que você deseja alcançar: observar estatísticas, gerenciar ofertas, trabalhar com usuários etc.

Os gerentes gerais podem usar os métodos marcados como métodos de administrador.

Em um método, você pode ver:

Onde:

  • 1: O método da API e o caminho a ser adicionado à sua solicitação de API.

  • 2: A lista de parâmetros disponíveis para um método.

  • 3: Tipo de dados para o parâmetro.

  • 4: Se relevante, dados ou formatos disponíveis e padrão que você deve usar.

  • 5: Na descrição, você pode encontrar informações adicionais sobre o parâmetro: do que ele é responsável, se é necessário ou não, e assim por diante.

No painel direito, você vê a resposta:

onde:

  • 1: a solicitação cURL, que você pode copiar, ajustar e usar nas ferramentas de API, como Postman ou Insomnia.

  • 2: o exemplo da resposta para um método específico. Aqui você pode ver os dados representados.

Você pode usar o documento dedicado com códigos de status. Isso pode ajudá-lo a entender os erros globais em suas respostas de API.


Entre em contato com a equipe de Suporte ao Cliente da Affise sobre todas as questões levantadas por meio do e-mail: [email protected].

Respondeu à sua pergunta?