Importar a nossa API no Insomnia e em outros clientes de API, e configurar a chave Bearer

A resposta curta: o Insomnia, e a maioria dos clientes de API, importa a nossa especificação OpenAPI e cria os pedidos todos de uma vez. O que muda de um cliente para outro é o nome dos menus; os passos são os mesmos: importar, pôr a chave numa variável, autenticar com Bearer e testar.

No Insomnia

1	Tenha à mão a especificação: o link está na Referência da API, seção Especificação, ou baixe o arquivo openapi.json.

2	Use a opção Import e escolha importar a partir de um link ou de um arquivo. O Insomnia reconhece o formato OpenAPI e cria os pedidos.

3	Crie um ambiente com uma variável para a chave, por exemplo rlx_api_key, com a sua chave sandbox_.

4	Na autenticação dos pedidos, ou da pasta que os junta, escolha Bearer Token e use a variável, por exemplo {{ _.rlx_api_key }}.

5	Teste com GET /v1/ping, sem chave, e depois com GET /v1/token.

Em outros clientes

Clientes como o Bruno e o Hoppscotch também importam especificações OpenAPI. Procure a opção de importar, escolha OpenAPI e siga a mesma ordem. Em qualquer um, a autenticação é sempre a mesma: o cabeçalho Authorization: Bearer seguido da chave.

Se a importação falhar

Sintoma	O que tentar
O cliente diz que não reconhece a versão	A especificação está em OpenAPI 3.1. Atualize o cliente: versões antigas de algumas ferramentas só lêem a 3.0.
A importação pelo link não funciona	Baixe o arquivo e importe-o a partir do disco.
Os pedidos vão para o endereço errado	Confirme o endereço base no ambiente ou na coleção. Os caminhos já começam por /v1.
Erro 401	A chave está em falta, mal escrita, revogada ou fora da validade. Veja se a variável tem valor no ambiente activo.

Um cliente de secretária guarda a chave nos dados dele. Use uma chave sandbox_ para ensaiar, não exporte coleções com a chave e, se a compartilhar por engano, revogue-a: o que fazer, pela ordem certa.

Prefere o Postman? Os passos dele, com as variáveis certas, estão em importar a API no Postman.

O link da especificação está no fim da Referência da API.

Ver a especificação

VEJA TAMBÉM

Importar a nossa API no Postman a partir da especificação OpenAPI, passo a passo

A especificação OpenAPI da nossa API: o que é, onde a baixar e o que contém

Gerar um cliente da API para a sua linguagem a partir da nossa especificação OpenAPI

A sua chave no Playground da API: onde fica, porquê começar com sandbox_ e o aviso das prod_

Uma chave de API ou um token ficou exposto: o que fazer, pela ordem certa

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde R$ 36,30/mês (plano de 3 anos, com cupom)

Ver planos

Categorias

Categorias