Como usar a documentação interativa

Após ler a introdução sobre a API, provavelmente você irá querer acessar a documentação que lista os métodos, parâmetros e retornos da API.

Dentro do plataforma, acesse o menu Configurações > Dados da Empresa > API & Webhooks e copie sua chave da API. Acesse a documentação, cole a chave e clique em "Explorar".

Para consultar os parâmetros ou retornos de um método específico, clique no recurso desejado, no método e verifique a descrição e o exemplo JSON. É neste local que você deverá consultar a arquitetura das requisições e quais são os parâmetros obrigatórios e opcionais.

Dentro da documentação você será capaz de realizar requisições reais para a plataforma.

Apenas como curiosidade, a Vindi utiliza a especificação Swagger para documentar a API e disponibilizar a documentação interativa.

Tem mais dúvidas? Envie uma solicitação

Comentários

  • Avatar
    Alberto Sasaki
    Editado por Alberto Sasaki
Powered by Zendesk