APIs¶

Informações necessárias para o tutorial¶

• Postman instalado;
• URL ou conteúdo de uma documentação de API em Swagger2 ou OpenApi3;
• Dados para configuração de um cliente OAuth;

Criando uma Collection a partir de uma documentação¶

Utilizaremos como exemplo o serviço PetStore https://petstore.swagger.io/v2/swagger.json, mas funciona com qualquer serviço que disponha de uma documentação Swagger2 ou OpenApi3

Configure a baseUrl¶

Conceitualmente, todo conjunto de apis possui uma URL base, que nada mais é do que o caminho onde o serviço possa ser acessado e identificado. Vamos configurá-la, tomando como exemplo tenant.area.totvs.app/produto/core/api/v1:

Configure a autenticação, se necessário¶

Vamos configurar uma autenticação para a coleção toda. Iremos utilizar como exemplo o rac_oidc. Mais detalhes na documentação: [Autenticando com o TOTVS RAC]

1

Todas as APIs de produtos TOTVS que estão no TOTVS APPS possuem a segurança baseada no protocolo OAuth 2. O TOTVS RAC é o autorizador utilizado.

Informações utilizadas no tutorial

• auth url: https://totvs.rac.dev.totvs.app/totvs.rac
• client id: rac_oidc
• scope: openid profile email authorization_api offline_access
• Client Authentication: Send as Basic Auth header

1

Importante: O token gerado possui data e hora de expiração, portanto será necessário clicar no botão **Get New Access Token** e repetir os últimos passos do gif.

Por fim, a chamada de uma API¶

Vamos utilizar a api de exemplo PetStore com a autenticação que configuramos anteriormente para criar um pet.