Postman — importar e testar

Visão Geral

A Hooked publica uma coleção Postman pronta com todos os endpoints públicos da API. Este guia mostra como importá-la, configurar suas credenciais uma única vez e disparar requisições reais em poucos minutos.

A coleção já vem com a variável {{base_url}} apontando para https://api.app.hooked.com.br e com Authorization: Bearer {{token}} em todos os endpoints autenticados. Você só precisa preencher o token — e isso acontece automaticamente após o primeiro login.

---

Passo 1 — Baixar a coleção

Baixar hooked-api.postman_collection.json

O arquivo é salvo na sua pasta de downloads.

---

Passo 2 — Importar no Postman

1. Abra o Postman (desktop ou versão web em web.postman.co).
2. No menu superior, vá em Workspaces e selecione um workspace existente ou clique em Create Workspace.
3. No painel esquerdo, localize a seção Collections. Clique nos três pontos (...) ao lado do título "Collections".
4. Escolha Import.
5. Arraste o arquivo hooked-api.postman_collection.json (ou clique em Choose files e selecione-o).
6. Confirme. A coleção Hooked API aparece na lista do workspace.

---

Passo 3 — Criar uma Environment

A environment guarda suas credenciais (URL base e token) separadas da coleção.

1. No painel esquerdo, vá em Environments e clique em + para criar uma nova.
2. Dê o nome Hooked — Produção.
3. Adicione duas variáveis:

Variable	Initial value	Current value
base_url	https://api.app.hooked.com.br	https://api.app.hooked.com.br
token	(deixe vazio)	(deixe vazio)

4. Clique em Save.
5. No canto superior direito da janela do Postman, abra o seletor de environment e escolha Hooked — Produção.

A coleção já tem variáveis padrão de mesmo nome no nível da própria coleção. A environment sobrescreve esses valores e é o caminho recomendado, especialmente se você usa mais de um ambiente (produção, staging, etc.).

---

Passo 4 — Fazer login e capturar o token

1. Na coleção Hooked API, abra a pasta Autenticação e selecione o request POST /api/conta/login.

2. Clique na aba Body. O corpo já vem preenchido como exemplo:

   {
     "email": "[email protected]",
     "password": "suaSenha"
   }
   

3. Substitua pelos seus dados reais e clique em Send.

4. A resposta 200 traz data.serviceToken. Não precisa copiar nada manualmente — a aba Tests do request já contém um script que detecta o serviceToken e grava na variável token da environment ativa.

5. Confirme que deu certo: vá em Environments → Hooked — Produção e veja a variável token preenchida.

O serviceToken expira após algumas horas. Quando qualquer endpoint começar a retornar 401, basta executar o login novamente — o script atualiza o {{token}} automaticamente.

---

Passo 5 — Testar outros endpoints

Todos os requests da coleção já carregam o header Authorization: Bearer {{token}}. Não precisa configurar nada por endpoint.

Exemplo rápido:

1. Abra Pessoas → GET /api/pessoas.
2. Clique em Send.
3. Você deve receber 200 com a lista paginada.

Para entender o formato de resposta (paginação, envelopes, etc.), consulte o guia de Paginação.

---

Solução de problemas

Sintoma	Causa provável	O que fazer
401 Unauthorized em todos os endpoints	Token expirado ou environment errada	Refazer o Passo 4 com a environment correta selecionada
Could not get response ou base_url is not defined	Environment não selecionada	Selecionar Hooked — Produção no canto superior direito
Login retorna 400	Body não foi importado corretamente	Baixar o arquivo novamente e reimportar
token continua vazio após login 200	Aba Tests do login removida ou environment não selecionada	Conferir se a environment está ativa e se o request de login tem script na aba Tests