Abrindo o portal

Uma API do Caminho Anglicano

Consultar status
Documentação

Antes da primeira chamada

Estêvão expõe calendário litúrgico, leituras, coletas, livros de oração e versões bíblicas. Esta referência explica como escolher a fonte dos dados e como conferir o que voltou.

Novo · API v2

Começando agora? Comece pela v2.

Respostas enxutas por padrão, include e fields para pedir só o que precisa, intervalos de datas em uma chamada e erros em problem+json. O sandbox do playground já fala v2.

Conhecer a v2

01 / Escopo

O que a API organiza

Os dados não aparecem isolados. Um dia pode apontar para seu tempo litúrgico, celebrações, coletas e leituras; uma leitura pode registrar o livro de oração e a variante de lecionário usados para selecioná-la.

Estrutura explícita

Preferências, códigos e metadados permanecem visíveis na resposta.

Escolhas conferíveis

A explicação litúrgica registra a origem das leituras e a variante selecionada.

02 / URL base

Todas as rotas partem daqui

Use HTTPS e envie a chave no cabeçalho X-API-Key, conforme descrito na próxima página. Há duas versões publicadas lado a lado.

v2https://api.caminhoanglicano.com.br/api/v2
v1https://api.caminhoanglicano.com.br/api/v1

A v2 é a superfície recomendada para integrações novas. A v1 continua no ar, sem data de desligamento: o aplicativo Ordo usa a v1, e quem já integrou não precisa migrar.

03 / Sequência sugerida

Um caminho curto até o primeiro JSON

  1. 01

    Entre no portal

    Use Google ou e-mail. No primeiro acesso, o perfil de desenvolvedor é criado pelo backend.

  2. 02

    Escolha um plano

    O plano define o limite de requisições das suas chaves. Os primeiros sete dias são de teste.

  3. 03

    Crie uma chave identificável

    Dê à chave o nome do projeto ou do ambiente. O valor completo aparece uma única vez.

  4. 04

    Consulte o catálogo

    Veja os livros de oração disponíveis e as preferências aceitas por cada edição.

  5. 05

    Faça uma chamada no playground

    Escolha um endpoint, confira os parâmetros e leia a resposta antes de levar a consulta ao código.

  6. 06

    Conecte sua aplicação

    Envie a chave no cabeçalho e mantenha-a fora de código público e do frontend.