Opening the portal

An API by Caminho Anglicano

Check status
Documentation

Before the first call

Estêvão exposes the liturgical calendar, readings, collects, prayer books and Bible versions. This reference explains how to choose where the data comes from and how to check what came back.

New · API v2

Starting now? Start with v2.

Lean responses by default, include and fields to ask for exactly what you need, date ranges in one call and problem+json errors. The playground sandbox already speaks v2.

Meet v2

01 / Scope

What the API arranges

The data never arrives isolated. A day can point to its liturgical season, celebrations, collects and readings; a reading can record the prayer book and the lectionary variant used to select it.

Explicit structure

Preferences, codes and metadata stay visible in the response.

Checkable choices

The liturgical explanation records where the readings came from and which variant was chosen.

02 / Base URL

Every route starts here

Use HTTPS and send your key in the X-API-Key header, as described on the next page. Two versions are published side by side.

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

v2 is the recommended surface for new integrations. v1 stays online with no shutdown date: the Ordo app runs on v1, and existing integrations do not have to migrate.

03 / Suggested sequence

A short path to the first JSON

  1. 01

    Sign in to the portal

    With Google or email. On the first visit the backend creates your developer profile.

  2. 02

    Choose a plan

    The plan sets your keys' request limit. The first seven days are a trial.

  3. 03

    Create a key you can recognise

    Name the key after the project or the environment. The full value is shown once.

  4. 04

    Read the catalogue

    See which prayer books are available and which preferences each edition accepts.

  5. 05

    Make a call in the playground

    Pick an endpoint, check the parameters and read the response before taking the query to code.

  6. 06

    Connect your application

    Send the key in the header and keep it out of public code and the frontend.