# APIBrasil v0.0.1 - Table of Contents

> SDK oficial Elixir da plataforma APIBrasil: WhatsApp, SMS, consultas de CPF/CNPJ, veiculos, CEP, correios, pagamentos PIX/boleto e mais.

## Pages

- [SDK ELIXIR - APIGratis by API BRASIL 💧](readme.md)
- [Changelog](changelog.md)
- [Política de segurança](security.md)
- [LICENSE](license.md)

## Modules

- [ApiBrasil](ApiBrasil.md): SDK oficial Elixir da plataforma [APIBrasil](https://apibrasil.com.br) —
WhatsApp, SMS, consultas de CPF/CNPJ, veículos, CEP, correios, pagamentos
PIX/boleto e muito mais.
- [ApiBrasil.Client](ApiBrasil.Client.md): Cliente já resolvido — o valor que todas as funções de serviço recebem
como primeiro argumento.
- [ApiBrasil.Consulta](ApiBrasil.Consulta.md): Monta o body das consultas por crédito (`POST /consulta/{servico}/credits`).

- Núcleo
  - [ApiBrasil.Core.Config](ApiBrasil.Core.Config.md): Configuração do cliente.
  - [ApiBrasil.Core.CreditResponse](ApiBrasil.Core.CreditResponse.md): Envelope de resposta das consultas por crédito
(`%{"error" => ..., "message" => ..., "balance" => ..., "tax" => ...,
"valor_consulta" => ..., "data" => ...}`).
  - [ApiBrasil.Core.DeviceResponse](ApiBrasil.Core.DeviceResponse.md): Envelope de resposta dos serviços *device-based*
(`%{"error" => ..., "message" => ..., "response" => ..., "api_limit" => ...}`).
  - [ApiBrasil.Core.Env](ApiBrasil.Core.Env.md): Variáveis de ambiente lidas pela SDK.
  - [ApiBrasil.Core.Error](ApiBrasil.Core.Error.md): Erro devolvido por todas as chamadas da SDK.
  - [ApiBrasil.Core.HTTP](ApiBrasil.Core.HTTP.md): Pipeline HTTP interno da SDK.
  - [ApiBrasil.Core.Hooks](ApiBrasil.Core.Hooks.md): Ganchos de observabilidade — logging, métricas, tracing.
  - [ApiBrasil.Core.JSON](ApiBrasil.Core.JSON.md): Codec JSON da SDK — sem dependência obrigatória.
  - [ApiBrasil.Core.Retry](ApiBrasil.Core.Retry.md): Política de retry da SDK.
  - [ApiBrasil.Core.Service](ApiBrasil.Core.Service.md): Base compartilhada por todos os serviços da SDK.
  - [ApiBrasil.Core.Transport](ApiBrasil.Core.Transport.md): Camada de transporte HTTP plugável.
  - [ApiBrasil.Core.Transport.Finch](ApiBrasil.Core.Transport.Finch.md): Transporte opcional sobre o [Finch](https://hex.pm/packages/finch) — pool
de conexões, HTTP/2 e telemetria.
  - [ApiBrasil.Core.Transport.Httpc](ApiBrasil.Core.Transport.Httpc.md): Transporte padrão da SDK, sobre o `:httpc` do Erlang/OTP — sem
dependências externas.
  - [ApiBrasil.Core.Transport.Request](ApiBrasil.Core.Transport.Request.md): Requisição entregue à camada de transporte.
  - [ApiBrasil.Core.Transport.Response](ApiBrasil.Core.Transport.Response.md): Resposta devolvida pela camada de transporte.
  - [ApiBrasil.Core.Utils](ApiBrasil.Core.Utils.md): Utilidades compartilhadas: montagem de URL, query string, normalização de
headers e conversão de bodies.

- Mensageria
  - [ApiBrasil.Messaging.Evolution](ApiBrasil.Messaging.Evolution.md): Evolution API (device-based): `POST /evolution/{controller}/{action}`.
  - [ApiBrasil.Messaging.SMS](ApiBrasil.Messaging.SMS.md): API de SMS (device-based): `POST /sms/{action}`.
  - [ApiBrasil.Messaging.WhatsApp](ApiBrasil.Messaging.WhatsApp.md): API de WhatsApp (device-based): `POST /whatsapp/{action}`.
  - [ApiBrasil.Messaging.WhatsMeow](ApiBrasil.Messaging.WhatsMeow.md): API WhatsMeow (device-based): `POST /whatsmeow/{action}`.

- Dados
  - [ApiBrasil.Data.Bulk](ApiBrasil.Data.Bulk.md): Execução em lote: `POST /bulk/direct/{action}` e `POST /bulk/queue/{action}`.
  - [ApiBrasil.Data.Cep](ApiBrasil.Data.Cep.md): CEP + geolocalização (device-based): `POST /cep/{action}`.
  - [ApiBrasil.Data.ChipVirtual](ApiBrasil.Data.ChipVirtual.md): Chip virtual: `POST /chip/virtual/*`.
  - [ApiBrasil.Data.Consulta](ApiBrasil.Data.Consulta.md): Consultas por crédito (`POST /consulta/{servico}/credits` e afins).
  - [ApiBrasil.Data.Correios](ApiBrasil.Data.Correios.md): Correios (device-based): `POST /correios/{action}`.
  - [ApiBrasil.Data.Dados](ApiBrasil.Data.Dados.md): Dados cadastrais device-based: `POST /dados/{action}`.
  - [ApiBrasil.Data.DatabaseIp](ApiBrasil.Data.DatabaseIp.md): GeoIP (device-based): `POST /database/ip`.
  - [ApiBrasil.Data.Ddd](ApiBrasil.Data.Ddd.md): Consulta de DDD (device-based): `POST /ddd/{action}`.
  - [ApiBrasil.Data.Fipe](ApiBrasil.Data.Fipe.md): Tabela FIPE (device-based): `POST /fipe/{action}`.
  - [ApiBrasil.Data.Geolocation](ApiBrasil.Data.Geolocation.md): Geolocalização (device-based): `POST /geolocation/{action}`.
  - [ApiBrasil.Data.Geomatrix](ApiBrasil.Data.Geomatrix.md): Matriz de distâncias (device-based): `POST /geomatrix/{action}`.
  - [ApiBrasil.Data.Holidays](ApiBrasil.Data.Holidays.md): Feriados (device-based): `POST /holidays/{action}`.
  - [ApiBrasil.Data.Loterias](ApiBrasil.Data.Loterias.md): Loterias (device-based): `POST /loterias/{sorteio}/*`.
  - [ApiBrasil.Data.Recognize](ApiBrasil.Data.Recognize.md): OCR / Google Vision (device-based): `POST /recognize/{action}`.
  - [ApiBrasil.Data.Translate](ApiBrasil.Data.Translate.md): Tradução (device-based): `POST /translate/{action}`.
  - [ApiBrasil.Data.Ura](ApiBrasil.Data.Ura.md): URA reversa / ligações: `POST /ura/call/*`.
  - [ApiBrasil.Data.Vehicles](ApiBrasil.Data.Vehicles.md): Veículos por placa (device-based): `POST /vehicles/{action}`.
  - [ApiBrasil.Data.Weather](ApiBrasil.Data.Weather.md): Clima (device-based): `POST /weather/{action}`.

- Plataforma
  - [ApiBrasil.Platform.Account](ApiBrasil.Platform.Account.md): Conta: saldo, faturas, notificações e tickets.
  - [ApiBrasil.Platform.Auth](ApiBrasil.Platform.Auth.md): Autenticação e conta (`/auth/*`, `/profile*`, `/password/*`).
  - [ApiBrasil.Platform.BearerRateLimit](ApiBrasil.Platform.BearerRateLimit.md): Rate limit por Bearer Token (`/bearer-rate-limit`).
  - [ApiBrasil.Platform.Catalog](ApiBrasil.Platform.Catalog.md): Catálogo público da plataforma: APIs, planos, documentações e servidores.
  - [ApiBrasil.Platform.Devices](ApiBrasil.Platform.Devices.md): Gestão de devices (`/devices/*`).
  - [ApiBrasil.Platform.IpWhitelist](ApiBrasil.Platform.IpWhitelist.md): IP Whitelist da conta (`/ip-whitelist/*`).
  - [ApiBrasil.Platform.Payments](ApiBrasil.Platform.Payments.md): Pagamentos e recargas (PIX, boleto e cartão): `/recharge`,
`/{provider}/pix/*`, `/{provider}/boleto/*`, `/mercadopago/card/*`.
  - [ApiBrasil.Platform.Reports](ApiBrasil.Platform.Reports.md): Relatórios e dashboard de consumo (`/reports/*`, `/dashboard/stats`).

- Catálogo
  - [ApiBrasil.Generated.Catalog](ApiBrasil.Generated.Catalog.md): Catálogo de endpoints conhecidos da plataforma APIBrasil —
ARQUIVO GERADO AUTOMATICAMENTE, não edite.

- Legado
  - [ApiBrasil.Legacy](ApiBrasil.Legacy.md): 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).

## Mix Tasks

- [mix apibrasil.codegen](Mix.Tasks.Apibrasil.Codegen.md): Gera `lib/api_brasil/generated/catalog.ex` a partir do catálogo público do
gateway APIBrasil (`GET /api/v2/documentations`).

