Catálogo de endpoints conhecidos da plataforma APIBrasil — ARQUIVO GERADO AUTOMATICAMENTE, não edite.
Fonte: https://gateway.apibrasil.io/api/v2/documentations
Regenerar: mix apibrasil.codegen
242 documentações, 550 endpoints, 210 tipos de consulta conhecidos.
ApiBrasil.Generated.Catalog.has_action?("whatsapp", "sendText")
#=> true
ApiBrasil.Generated.Catalog.service_actions("correios")
#=> ["rastreio"]
ApiBrasil.Generated.Catalog.consulta_tipo("acerta-essencial")
#=> %{service: "cpf", fields: ["cpf"]}
Summary
Functions
Serviços de consulta por crédito (POST /consulta/{servico}/credits).
Metadados de um tipo de consulta — o serviço da rota
(POST /consulta/{servico}/credits) e os campos do body de exemplo, fora
tipo e homolog. Devolve nil quando o tipo não está no catálogo.
Metadados por tipo de consulta (campo tipo do body), ordenados por tipo.
Caminhos conhecidos da Evolution API
(POST /evolution/{controller}/{action}).
Informa se uma action é documentada para o serviço.
Actions documentadas por serviço do gateway, ordenadas por serviço.
Actions documentadas de um serviço do gateway — lista vazia quando o serviço não está no catálogo.
Serviços do gateway presentes no catálogo, em ordem alfabética.
Fonte do catálogo.
Actions conhecidas da API de WhatsApp (POST /whatsapp/{action}).
Actions conhecidas do WhatsMeow (POST /whatsmeow/{action}).
Functions
@spec consulta_servicos() :: [String.t()]
Serviços de consulta por crédito (POST /consulta/{servico}/credits).
Metadados de um tipo de consulta — o serviço da rota
(POST /consulta/{servico}/credits) e os campos do body de exemplo, fora
tipo e homolog. Devolve nil quando o tipo não está no catálogo.
ApiBrasil.Generated.Catalog.consulta_tipo("acerta-essencial")
#=> %{service: "cpf", fields: ["cpf"]}
Metadados por tipo de consulta (campo tipo do body), ordenados por tipo.
@spec evolution_paths() :: [String.t()]
Caminhos conhecidos da Evolution API
(POST /evolution/{controller}/{action}).
Informa se uma action é documentada para o serviço.
Actions documentadas por serviço do gateway, ordenadas por serviço.
Actions documentadas de um serviço do gateway — lista vazia quando o serviço não está no catálogo.
@spec services() :: [String.t()]
Serviços do gateway presentes no catálogo, em ordem alfabética.
@spec source() :: String.t()
Fonte do catálogo.
@spec whatsapp_actions() :: [String.t()]
Actions conhecidas da API de WhatsApp (POST /whatsapp/{action}).
@spec whatsmeow_actions() :: [String.t()]
Actions conhecidas do WhatsMeow (POST /whatsmeow/{action}).