Parâmetros de pesquisa disponíveis

Última atualização: há 3 meses

O endpoint /resources aceita vários parâmetros para refinar os resultados da sua pesquisa.

Pesquisa básica

POST https://api.cathopic.com/resources
{
  "query": "São Francisco",
  "page": 1,
  "page_size": 20,
  "order": "popular"
}

Parâmetros

query (string, opcional)

Seu termo de pesquisa. Deixe em branco para obter todos os recursos.

  • Exemplos: "Virgem Maria", "Eucaristia", "cruz"

  • Suporta correspondência aproximada e tolerância a erros de digitação

  • Pesquisa em títulos, descrições e tags

page (inteiro, padrão: 1)

Qual página de resultados retornar. Começa em 1.

page_size (inteiro, padrão: 20, máximo: 100)

Número de resultados por página. O máximo é 100 para manter o desempenho.

order (string, padrão: "popular")

Como ordenar os resultados:

  • popular - Recursos mais baixados primeiro

  • recent - Envios mais recentes primeiro

Estrutura da resposta

{
  "total": 1523,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": 1234,
      "name": "Título do recurso",
      "description": "Descrição do recurso",
      "type": "photo",
      "orientation": "portrait",
      "thumbnail_url": "https://...",
      "author": { ... },
      "tags": ["tag1", "tag2"]
    }
  ]
}

Exemplos práticos

Obtenha os 10 primeiros recursos mais populares sobre oração:

{
  "query": "oração",
  "page": 1,
  "page_size": 10,
  "order": "popular"
}

Obtenha envios recentes, sem termo de pesquisa específico:

{
  "query": "",
  "page": 1,
  "page_size": 50,
  "order": "recent"
}

Navegue pela página 3 de imagens de santos:

{
  "query": "santos",
  "page": 3,
  "page_size": 20,
  "order": "popular"
}

Para a referência completa da API, visite api.cathopic.com/docs.

Este artigo foi útil?