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

A resposta curta: o Postman lê a nossa especificação OpenAPI e cria uma colecção com todos os pedidos da API, arrumados por área. Depois basta pôr a chave num sítio só e começar a experimentar, fora do navegador e com os seus próprios pedidos guardados.

Passo a passo

1	Copie a ligação da especificação, na Referência da API, secção Especificação, ou descarregue o ficheiro openapi.json.

2	No Postman, carregue em Import e cole a ligação, ou arraste o ficheiro para a janela.

3	Escolha importar como colecção. Se o Postman oferecer a opção de organizar as pastas por etiquetas (tags), use-a: as pastas ficam iguais às áreas da documentação.

4	Crie um ambiente com uma variável para a chave, por exemplo rlx_api_key, e ponha a sua chave sandbox_ no valor actual.

5	Na colecção, separador Authorization, escolha Bearer Token e escreva {{rlx_api_key}}. Os pedidos que herdam a autenticação da colecção passam a usá-la.

6	Confirme o endereço: a importação costuma criar uma variável com o endereço base, a partir da especificação. Veja que aponta para a API da MozOut.

7	Teste: primeiro GET /v1/ping, que não pede chave, e depois GET /v1/token, que mostra o que a chave pode fazer.

Cuidado com onde fica a chave. No Postman, o valor inicial de uma variável é partilhado com quem tem acesso ao espaço de trabalho; o valor actual fica, por omissão, só no seu computador. Ponha a chave só no valor actual, e nunca exporte nem partilhe uma colecção com a chave lá dentro.

Detalhes que poupam surpresas

Detalhe	O que fazer
Mensagens de erro em português	Acrescente o cabeçalho Accept-Language: pt aos pedidos.
Pedidos POST	Envie Idempotency-Key com um valor único. No Postman, a variável dinâmica {{$guid}} gera um em cada envio.
Nomes das operações em inglês	É normal: as ferramentas lêem os textos ingleses da especificação.
A API mudou	Volte a importar a especificação. A data «Actualizado em» da Referência ajuda a saber quando.

Antes de usar uma chave prod_, faça os mesmos pedidos com a sandbox_: as escritas são simuladas e nunca cobram. Mais sobre o ficheiro em a especificação OpenAPI.

A ligação da especificação está no fim da Referência da API.

Ver a especificação

VEJA TAMBÉM

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

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

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 cupão)

Ver planos

Categorias

Categorias

Suporte

Passo a passo

Detalhes que poupam surpresas

Categorias

Categorias

Suporte

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

Passo a passo

Detalhes que poupam surpresas

Artigos Relacionados

Gerar Senha