Referência

Explorador (Swagger)

A API de integração em Swagger: todas as operações, parâmetros, corpos, respostas e modelos, para perceber o que a API aceita e devolve.

O Swagger é uma forma de ver a API como um mapa: todas as operações agrupadas por área, com os parâmetros, o corpo de cada pedido, as respostas possíveis e os modelos de dados, tudo gerado a partir do mesmo ficheiro OpenAPI que o servidor aplica. Serve para perceber o que a API aceita e devolve antes de escrever código.

• Pesquise uma operação pela caixa «Filter by tag» (o filtro percorre as áreas: Clientes, Documentos, Eventos…).
• Abra uma operação para ver os parâmetros (e quais são obrigatórios), o exemplo de corpo e as respostas 200, 400, 401, 403… com o seu formato.
• Veja os modelos (os objectos que a API troca) abrindo o pedido ou a resposta e escolhendo «Schema».
• Os exemplos com valores reais, a permissão que cada operação exige e as regras estão na Referência.

#Porque não há «Experimentar» aqui

É de propósito. Uma chave de API dá poderes sobre a empresa, e tudo o que corre num browser pode ser lido por quem o usa. Por isso a API não aceita pedidos feitos a partir de páginas de internet e este explorador só mostra, não envia. Para experimentar de verdade, use uma ferramenta no seu computador ou o seu servidor (ver abaixo).

#Do Swagger ao seu código