Ir para o conteúdo
← Documentação

Como usar a coleção do Postman

Todos os 299 endpoints, cada um com um corpo de requisição já testado na API de produção. Faça um fork, defina sua chave uma vez e envie uma requisição real sem escrever uma linha de código.

1

Gere uma chave de API

Todas as requisições da coleção são autenticadas, então nada devolve dados até você ter uma chave. Criar chaves é grátis; você só gasta créditos quando a chamada dá certo.

  1. 1Crie uma conta em occultapi.com/signup e confirme seu e-mail.
  2. 2No painel, abra API keys e clique em Create key.
  3. 3Copie a chave na hora. Ela aparece uma única vez e fica guardada como hash, então ninguém — nem nós — consegue mostrá-la de novo. Se perder, você faz a rotação; não tem como recuperar.
2

Abra a coleção

A coleção é pública, então não há nada para importar: o link abre tudo no navegador, com todas as pastas, requisições e respostas prontas para navegar. Para ler, você nem precisa de conta no Postman.

As requisições seguem os mesmos grupos da referência: Panchang, Muhurta, Dashas, Charts, Calendars e assim por diante. Cada uma traz a mesma descrição da documentação e o mesmo corpo usado para capturar a resposta de exemplo.

A coleção da Occult API aberta no Postman, com a lista de pastas e a visão geral da coleção
A coleção ao abrir: pastas à esquerda, visão geral à direita.
3

Faça um fork no seu workspace

Para ler a coleção, não precisa de conta; para enviar requisições, você precisa de uma cópia sua. O fork cria essa cópia.

  1. 1Entre no Postman ou crie uma conta gratuita.
  2. 2Clique em Fork Collection no topo da coleção, ou no ícone de fork ao lado do nome.
  3. 3Dê um rótulo ao fork — pode ser o seu nome — e escolha o workspace onde ele vai ficar.
  4. 4Deixe Watch original collection marcado. É isso que permite puxar endpoints novos depois, sem fazer outro fork.
  5. 5Clique em Fork Collection. Sua cópia abre, e nada do que você mudar nela afeta a nossa.

Prefere não ter conta no Postman? Baixe o JSON e use Import no app desktop do Postman. Você perde o vínculo de atualização e vai precisar importar de novo quando a API ganhar endpoints.

4

Defina sua chave de API

Abra a aba Variables da coleção. São duas: baseUrl, já preenchida com https://api.occultapi.com, e apiKey, em branco. Cole sua chave no valor de apiKey e salve.

Esse é o único passo de autenticação. Todas as requisições da coleção herdam a chave daqui e a enviam no cabeçalho X-API-Key: você define uma vez, e não em 299 requisições. Ainda não tem chave? Gere uma no seu painel.

A aba Variables da coleção, com baseUrl apontando para o host da API e apiKey vazia
Aba Variables. Cole sua chave em apiKey — a baseUrl já está definida.

Deixe a chave no servidor. Uma chave de API é uma credencial, não um identificador público. Use-a no Postman e no seu backend, mas nunca a coloque no JavaScript do navegador nem num app mobile, onde qualquer um pode extraí-la e gastar seus créditos.

5

Envie sua primeira requisição

Toda requisição é POST com corpo JSON, e a URL usa {{baseUrl}}, então você nunca digita o host. A descrição de cada uma é o mesmo texto da página correspondente na referência.

  1. 1Abra uma pasta na barra lateral — Astrology / Dasha é um bom começo — e clique numa requisição.
  2. 2Confira se a aba Authorization indica que está herdando da coleção. É a apiKey que você acabou de definir; não precisa adicionar cabeçalho nenhum.
  3. 3Clique em Send. O corpo já vem com valores válidos, então a primeira chamada funciona sem editar nada.
Uma requisição de dasha aberta no Postman, com o método POST, a variável baseUrl na URL e o corpo JSON
A requisição como ela vem: método, URL, autenticação herdada da coleção e um corpo JSON que funciona.
6

Use seus próprios dados

Abra a aba Body e edite os valores. Quatro campos concentram quase tudo de que um mapa precisa — e errar neles costuma gerar uma resposta sutilmente errada, não uma mensagem de erro.

  1. 1date_time — ISO 8601, e sempre com o offset (+05:30) ou um Z no final. Um valor sem fuso é lido como Asia/Kolkata, o que desloca o mapa sem aviso para qualquer pessoa fora da Índia.
  2. 2latitude e longitude — em graus decimais, não em graus e minutos. Cuidado com o sinal: esquecer um sinal de menos põe Nova York na China.
  3. 3timezone_as_float — o offset em horas, como número decimal. 5.5 para a Índia, -5 para Nova York.
  4. 4Se o JSON ficar bagunçado, clique em Beautify e depois em Send de novo.
A aba Body de uma requisição no Postman, com o JSON bruto contendo date_time, latitude, longitude, timezone_as_float e levels
A aba Body. Troque estes valores pelos seus e envie de novo.
7

Leia a resposta — e veja quanto custou

O painel de resposta abre logo abaixo. O corpo traz os dados; os cabeçalhos mostram o efeito da chamada no seu saldo.

  1. 1Body — o JSON. Tudo fica sob a chave data, com message e is_error ao lado.
  2. 2Headers — X-Credits-Cost é o preço do endpoint, X-Credits-Charged é o que de fato foi cobrado de você e X-Credits-Remaining é o saldo que sobrou.
  3. 3Charged mostra 0 em qualquer falha — corpo mal formado, data inválida, erro nosso. Teste à vontade: você só paga pelas chamadas que devolveram dados.
  4. 4Clique em Save as example para guardar a resposta na requisição. Assim sua equipe vê o formato sem gastar crédito.
8

Gere código na sua linguagem

Quando a requisição fizer o que você quer, o Postman escreve o código na sua linguagem. Abra o ícone </> Code na barra da direita e escolha cURL, Python, Node, PHP, Go ou outra.

O trecho troca {{baseUrl}} pelo host real e já inclui o cabeçalho X-API-Key, então roda do jeito que está. Antes de fazer commit, troque a chave por uma variável de ambiente — o trecho contém uma credencial ativa.

O painel de código do Postman, mostrando a requisição como comando cURL com o cabeçalho da chave de API
O painel Code. A mesma requisição em cURL, pronta para colar num terminal ou script.
9

Rode uma pasta inteira de uma vez

O botão Run, no topo de uma coleção ou pasta, envia todas as requisições dela em sequência. Serve para conferir se uma chave funciona numa categoria inteira, ou como smoke test depois de alguma mudança.

Lembre que cada chamada bem-sucedida gasta um crédito: rodar todos os 299 custa 299 créditos — na verdade mais, porque o endpoint de chat e os dois relatórios em PDF custam 25 cada. Rode uma pasta, não a coleção inteira, a não ser que seja mesmo essa a intenção.

10

Mantenha seu fork atualizado

A coleção é gerada a partir do mesmo catálogo que gera a documentação, então ganha endpoints junto com a API.

  1. 1Quando o original muda, o Postman mostra a opção pull changes no seu fork.
  2. 2Ao aceitar, as requisições novas chegam sem mexer nos corpos que você editou nem nas variáveis que definiu.
  3. 3O changelog mostra o que foi adicionado e quando, para você decidir se vale a pena puxar.