Modules
SDK oficial Elixir da plataforma APIBrasil — WhatsApp, SMS, consultas de CPF/CNPJ, veículos, CEP, correios, pagamentos PIX/boleto e muito mais.
Cliente já resolvido — o valor que todas as funções de serviço recebem como primeiro argumento.
Monta o body das consultas por crédito (POST /consulta/{servico}/credits).
Configuração do cliente.
Envelope de resposta das consultas por crédito
(%{"error" => ..., "message" => ..., "balance" => ..., "tax" => ..., "valor_consulta" => ..., "data" => ...}).
Envelope de resposta dos serviços device-based
(%{"error" => ..., "message" => ..., "response" => ..., "api_limit" => ...}).
Variáveis de ambiente lidas pela SDK.
Erro devolvido por todas as chamadas da SDK.
Pipeline HTTP interno da SDK.
Ganchos de observabilidade — logging, métricas, tracing.
Codec JSON da SDK — sem dependência obrigatória.
Política de retry da SDK.
Base compartilhada por todos os serviços da SDK.
Camada de transporte HTTP plugável.
Transporte opcional sobre o Finch — pool de conexões, HTTP/2 e telemetria.
Transporte padrão da SDK, sobre o :httpc do Erlang/OTP — sem
dependências externas.
Requisição entregue à camada de transporte.
Resposta devolvida pela camada de transporte.
Utilidades compartilhadas: montagem de URL, query string, normalização de headers e conversão de bodies.
Execução em lote: POST /bulk/direct/{action} e POST /bulk/queue/{action}.
CEP + geolocalização (device-based): POST /cep/{action}.
Chip virtual: POST /chip/virtual/*.
Consultas por crédito (POST /consulta/{servico}/credits e afins).
Correios (device-based): POST /correios/{action}.
Dados cadastrais device-based: POST /dados/{action}.
GeoIP (device-based): POST /database/ip.
Consulta de DDD (device-based): POST /ddd/{action}.
Tabela FIPE (device-based): POST /fipe/{action}.
Geolocalização (device-based): POST /geolocation/{action}.
Matriz de distâncias (device-based): POST /geomatrix/{action}.
Feriados (device-based): POST /holidays/{action}.
Loterias (device-based): POST /loterias/{sorteio}/*.
OCR / Google Vision (device-based): POST /recognize/{action}.
Tradução (device-based): POST /translate/{action}.
URA reversa / ligações: POST /ura/call/*.
Veículos por placa (device-based): POST /vehicles/{action}.
Clima (device-based): POST /weather/{action}.
Catálogo de endpoints conhecidos da plataforma APIBrasil — ARQUIVO GERADO AUTOMATICAMENTE, não edite.
Interface legada da SDK, mantida por compatibilidade com o formato de
chamada das primeiras SDKs da plataforma (credentials, body e action
em uma única string JSON).
Evolution API (device-based): POST /evolution/{controller}/{action}.
API de SMS (device-based): POST /sms/{action}.
API de WhatsApp (device-based): POST /whatsapp/{action}.
API WhatsMeow (device-based): POST /whatsmeow/{action}.
Conta: saldo, faturas, notificações e tickets.
Autenticação e conta (/auth/*, /profile*, /password/*).
Rate limit por Bearer Token (/bearer-rate-limit).
Catálogo público da plataforma: APIs, planos, documentações e servidores.
Gestão de devices (/devices/*).
IP Whitelist da conta (/ip-whitelist/*).
Pagamentos e recargas (PIX, boleto e cartão): /recharge,
/{provider}/pix/*, /{provider}/boleto/*, /mercadopago/card/*.
Relatórios e dashboard de consumo (/reports/*, /dashboard/stats).
Mix Tasks
Gera lib/api_brasil/generated/catalog.ex a partir do catálogo público do
gateway APIBrasil (GET /api/v2/documentations).