Referência / Fontes

Livros de oração

Liste as edições disponíveis e consulte os ofícios, recursos e preferências próprios de cada livro.

Estrutura litúrgica

O catálogo identifica cada livro por código e informa idioma, jurisdição, ofícios disponíveis e preferências compatíveis. O BCP 1662 em inglês, por exemplo, expõe suas variantes de lecionário como opções do mesmo livro.

GET/api/v1/prayer_books

Trecho da resposta200 OK

{
  "data": [
    {
      "id": "loc_2015",
      "code": "loc_2015",
      "name": "IEAB - 2015",
      "full_name": "IEAB - 2015",
      "description": "LOC atual da IEAB, parte de uma nova geração de Livros de Oração",
      "language": "pt-BR",
      "jurisdiction": "Igreja Episcopal Anglicana do Brasil",
      "year": 2015,
      "thumbnail_url": "https://caminhoanglicano.com.br/locs/thumbs/loc-2015.png",
      "pdf_url": "https://caminhoanglicano.com.br/locs/pdfs/loc-2015.pdf",
      "supports_family_rite": true,
      "available_offices": ["morning", "midday", "evening", "compline"],
      "office_definitions": {
        "standard": [
          { "key": "morning", "name": "Matutino" }
        ],
        "family": [
          { "key": "morning", "name": "De Manhã" }
        ]
      },
      "is_recommended": true,
      "premium_required": false,
      "is_accessible": true
    }
  ]
}

Preferências por livro

As opções não ficam fixas no cliente. Consulte o catálogo de preferências do livro para montar os controles e enviar apenas valores aceitos pela API.

GET/api/v1/prayer_books/:prayer_book_code/preferences

Exemplo — BCP 1662

{
  "prayer_book_id": "loc_1662_en",
  "categories": [
    {
      "key": "daily_office",
      "preferences": [
        {
          "key": "lectionary_variant",
          "type": "select_one",
          "default_value": "original_1662",
          "options": [
            { "value": "original_1662", "is_default": true },
            { "value": "revised_1871", "is_default": false },
            { "value": "revised_1922", "is_default": false }
          ]
        }
      ]
    }
  ]
}

Nota: as três tabelas do BCP 1662 são variantes do mesmo livro (loc_1662_en), não livros separados. A preferência psalm_translation também aparece nesse catálogo, com as opções bible_version e coverdale.

Descrição dos campos

Campo	Descrição
id / code	Identificador único do livro (ex: loc_2015).
jurisdiction	Entidade eclesiástica autorizadora (Igreja, Diocese ou Província).
thumbnail_url	Link para a imagem da capa do livro.
image_url	Link para a imagem principal da capa, quando disponível.
pdf_url	Link para o arquivo PDF oficial do livro de oração.
available_offices	Lista técnica dos ofícios contidos no livro (morning, midday, evening, compline).
supports_family_rite	Indica se o livro oferece as formas familiares do ofício.
office_definitions	Mapeamento de nomes amigáveis para cada ofício em diferentes modos de oração.
is_recommended	Indica se este é o livro padrão sugerido para o idioma.
premium_required	Se true, o acesso requer conta premium no app Estêvão.
is_accessible	Indica se o livro está disponível para o nível de acesso da chave atual.
preferences	Catálogo retornado pelo endpoint /prayer_books/:prayer_book_code/preferences, com tipo, padrão e opções de cada preferência.