Module: ApiBrasil

Defined in:

lib/api_brasil.rb,
lib/api_brasil/client.rb,
lib/api_brasil/version.rb,
lib/api_brasil/core/env.rb,
lib/api_brasil/core/retry.rb,
lib/api_brasil/core/errors.rb,
lib/api_brasil/core/transport.rb,
lib/api_brasil/legacy/service.rb,
lib/api_brasil/core/http_client.rb,
lib/api_brasil/generated/catalog.rb,
lib/api_brasil/services/base_service.rb,
lib/api_brasil/services/data/proxies.rb,
lib/api_brasil/services/data/cep_service.rb,
lib/api_brasil/services/data/ura_service.rb,
lib/api_brasil/services/data/bulk_service.rb,
lib/api_brasil/services/data/fipe_service.rb,
lib/api_brasil/services/data/dados_service.rb,
lib/api_brasil/services/device_proxy_service.rb,
lib/api_brasil/services/data/consulta_service.rb,
lib/api_brasil/services/data/correios_service.rb,
lib/api_brasil/services/data/vehicles_service.rb,
lib/api_brasil/services/messaging/sms_service.rb,
lib/api_brasil/services/platform/auth_service.rb,
lib/api_brasil/core/transport/faraday_transport.rb,
lib/api_brasil/core/transport/net_http_transport.rb,
lib/api_brasil/services/data/database_ip_service.rb,
lib/api_brasil/services/platform/account_service.rb,
lib/api_brasil/services/platform/catalog_service.rb,
lib/api_brasil/services/platform/devices_service.rb,
lib/api_brasil/services/platform/reports_service.rb,
lib/api_brasil/services/data/chip_virtual_service.rb,
lib/api_brasil/services/platform/payments_service.rb,
lib/api_brasil/services/messaging/whatsapp_service.rb,
lib/api_brasil/services/messaging/evolution_service.rb,
lib/api_brasil/services/messaging/whats_meow_service.rb,
lib/api_brasil/services/platform/ip_whitelist_service.rb,
lib/api_brasil/services/platform/bearer_rate_limit_service.rb

Overview

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

require "api_brasil"

api = ApiBrasil.new(
bearer_token: ENV["APIBRASIL_BEARER_TOKEN"],
device_token: ENV["APIBRASIL_DEVICE_TOKEN"]
)

api.whatsapp.send_text("number" => "5511999999999", "text" => "Ola!")

Documentacao completa: https://doc.apibrasil.io

Defined Under Namespace

Modules: Core, Generated, Legacy, Services Classes: Client

Constant Summary

HttpClient =

Tipos do core reexportados para que o uso do dia a dia precise de um unico require.

Core::HttpClient

Env =

Core::Env

Retry =

Core::Retry

Transport =

Core::Transport

TransportRequest =

Core::Transport::Request

TransportResponse =

Core::Transport::Response

NetHttpTransport =

Core::Transport::NetHttpTransport

FaradayTransport =

Core::Transport::FaradayTransport

Catalog =

Generated::Catalog

ApiBrasilError =

Hierarquia de erros.

Core::Errors::ApiBrasilError

ValidationError =

Core::Errors::ValidationError

AuthenticationError =

Core::Errors::AuthenticationError

InsufficientBalanceError =

Core::Errors::InsufficientBalanceError

PermissionError =

Core::Errors::PermissionError

NotFoundError =

Core::Errors::NotFoundError

RateLimitError =

Core::Errors::RateLimitError

ServerError =

Core::Errors::ServerError

NetworkError =

Core::Errors::NetworkError

TimeoutError =

Core::Errors::TimeoutError

ErrorFactory =

Core::Errors::ErrorFactory

VERSION =

Versao da SDK, usada tambem no header User-Agent.

"0.0.1"

Class Method Summary

• .login(credentials, config = {}) ⇒ Hash

  Faz login e devolve { client:, session: } com o cliente ja autenticado.

• .new(config = {}) ⇒ ApiBrasil::Client

  Cria um cliente da plataforma.

Class Method Details

.login(credentials, config = {}) ⇒ Hash

Faz login e devolve { client:, session: } com o cliente ja autenticado.

Parameters:

• credentials (Hash) —

  email e password

• config (Hash) (defaults to: {})

Returns:

• (Hash)

# File 'lib/api_brasil.rb', line 68

def login(credentials, config = {})
  Client.login(credentials, config)
end

.new(config = {}) ⇒ ApiBrasil::Client

Cria um cliente da plataforma.

ApiBrasil.new(bearer_token: "...", device_token: "...")

Parameters:

• config (Hash) (defaults to: {}) —

  veja ApiBrasil::Core::HttpClient

Returns:

• (ApiBrasil::Client)

# File 'lib/api_brasil.rb', line 59

def new(config = {})
  Client.new(config)
end