A coleção do Postman foi criada com o intuito de fornecer exemplos práticos dos principais métodos da API principal da Betalabs. Com ela, é possível, com poucos cliques, executar requisições para o ambiente do seu projeto a fim de analisar os envios e respostas para a sua integração. Para isso, algumas configurações simples devem ser feitas na coleção.

Importando a coleção

O link para importar a coleção está disponível na página a seguir da base de conhecimento no botão laranja. Após clicar e importar a coleção ficará disponível no menu a esquerda:

Trabalhando com variáveis

Uma série de variáveis foram configuradas entre as requisições da coleção, de forma que cada projeto deverá ter os seus valores específicos. As variáveis podem ser identificadas nas coleções pela cor diferenciada e por estarem entre chaves duplas: {{variavel}}. A seguir vamos ver como acessá-las para editá-las com os valores do seu projeto.

Editando variáveis

No item da coleção no menu da esquerda, clique no botão de ações da coleção e em seguida em "Editar":

No painel de edição, acesse a aba Variáveis:

Veja que uma série de variáveis estão declaradas com valores vazios. Você precisará preencher os valores correspondentes ao seu projeto. Dependendo da sua necessidade, nem todas precisarão ser preenchidas. Abaixo vamos descrever as principais - que devem ser definidas para serem usadas em todas as requisições:

• project
  Define o prefixo do seu projeto para ser usado em todas as URLs. É o mesmo valor da URL de acesso da loja em ambiente de testes e do painel administrativo da loja (https://nome-do-seu-projeto.store.betalabs.net e https://nome-do-seu-projeto.app.betalabs.net, respectivamente).
• accessToken
  Chave de autenticação a ser obtida junto a equipe de atendimento da betalabs após credenciamento entre os usuários do projeto.

As demais variáveis aparecerão em contextos específicos, geralmente para indicar nas requisições os valores a serem substituídos por valores reais.

Corpos das requisições

A API permite dois tipos de corpo para as requisições que atendem as necessidades de envio das informações de forma textual e/ou arquivos. O tipo enviado deverá ser informado em conjunto com o cabeçalho Content-Type correspondente. O Postman auxilia preenchendo o Content-Type correspondente ao escolher o tipo de corpo no momento de criação da requisição:

O formato form-data deve ser utilizado caso queira enviar arquivos na requisição junto a outras informações no formato de texto. Em todas as outras situações, caso queira informar somente texto, recomendamos sempre usar o formato JSON.

Corpo form-data

Ao selecionar o formato do campo em form-data vá até a seção de cabeçalho e observe que o Postman preenche automaticamente a entrada Content-Type (pode estar oculto). Caso não esteja preechido, você poderá entrar com o valor correspondente logo abaixo em uma nova entrada:

Corpo JSON

Para informar o corpo usando a notação de objeto JavaScript (JSON) escolha a opção raw entre as opções de corpo e em seguida o formato JSON:

Feito isso confirme o cabeçalho Content-Type na seção de entradas de cabeçalho e, caso não esteja preenchido (pode estar oculto), informe o valor application/json:

Exemplos

Em algumas requisições estão disponíveis exemplos de preenchimento e resposta, para auxiliar em desenvolvimentos de integrações. Esses exemplos podem variar dos campos em ambiente de produção dependendo dos campos extras cadastrados em cada projeto. Veja aqui a forma em que os campos extras são referenciados na API.
Para acessar os exemplos, observe o link no canto superior direito das requisições: