Download the PHP package jhowbhz/apigratis-sdk-php without Composer

On this page you can find all versions of the php package jhowbhz/apigratis-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of jhowbhz/apigratis-sdk-php

Informations about the package apigratis-sdk-php

SDK PHP - APIGratis by APIBrasil 🚀

SDK oficial PHP da plataforma APIBrasil — WhatsApp, SMS, consultas de CPF/CNPJ, veículos, CEP, correios, pagamentos PIX/boleto e muito mais.

latest stable version license mit GitHub issues GitHub forks GitHub stars Minimum PHP Version

Canais de suporte (Comunidade)

WhatsApp Channel Telegram Group

Instalação

Requer PHP >= 8.0. Usa Guzzle quando disponível e cai automaticamente para cURL — a camada de transporte é plugável.

Obtenha suas credenciais em https://apibrasil.com.br

Começando

As credenciais também podem vir só do ambiente — new ApiBrasil() lê automaticamente APIBRASIL_BEARER_TOKEN, APIBRASIL_DEVICE_TOKEN, APIBRASIL_SECRET_KEY e APIBRASIL_BASE_URL.

Todas as respostas são devolvidas como array associativo já decodificado.

Também é possível autenticar por email/senha — o token retornado fica guardado no cliente:

Como a plataforma funciona

A API Brasil tem duas famílias de serviços:

Família Autenticação Exemplos
Device-based Authorization: Bearer + header DeviceToken WhatsApp, SMS, veículos, CEP, correios, DDD, feriados, tradução, clima, OCR
Por créditos apenas Authorization: Bearer (debita saldo) consulta->cpf, consulta->cnpj, consulta->veiculos, Serasa, CNH, telefone

Para os serviços device-based, crie um device com a SecretKey da API desejada (painel APIBrasil) e use o device_token retornado:

Serviços disponíveis

Módulo Descrição
$api->whatsapp WhatsApp: start, qrcode, sendText, sendFile, sendAudio, sendVideo, fila (queue)...
$api->evolution Evolution API: request($controller, $action, $body)
$api->whatsmeow WhatsMeow: request($action, $body)
$api->sms SMS device-based (send) e por créditos (sendWithCredits)
$api->dados Dados cadastrais device-based (cpf, cnpj)
$api->vehicles Veículos por placa (dados, fipe, consultaFipe)
$api->fipe Tabela FIPE (request($action, $body))
$api->correios Correios (rastreio, request)
$api->cep CEP + geolocalização (cep, request)
$api->geolocation / $api->geomatrix Geolocalização e matriz de distâncias
$api->recognize OCR / Google Vision
$api->ddd / $api->holidays / $api->translate / $api->weather DDD, feriados, tradução, clima
$api->databaseIp GeoIP (ip)
$api->consulta Consultas por créditos: cpf, cnpj, cnh, cep, veiculos, telefone, generic($service, $body)
$api->ura / $api->chipVirtual URA reversa e chip virtual
$api->bulk Execução em lote (direct, queue)
$api->auth Login, 2FA, cadastro, recuperação de senha, perfil
$api->devices CRUD de devices
$api->catalog Catálogo de APIs, planos, documentações, servidores
$api->account Saldo, faturas, notificações, tickets
$api->payments Recargas e pagamentos PIX/boleto/cartão (Santander, Inter, Mercado Pago, Sicoob)
$api->ipWhitelist / $api->bearerRateLimit Segurança da conta
$api->reports Relatórios e dashboard de consumo

WhatsApp

Consultas por créditos

Veículos e FIPE (device-based)

SMS

Pagamentos e recargas

Múltiplos devices

Tratamento de erros

Cada categoria de falha tem a sua própria classe — todas estendem ApiBrasilError (que por sua vez estende RuntimeException):

Classe Quando
ValidationError 400/422 — payload inválido
AuthenticationError 401 — token ausente/expirado
InsufficientBalanceError 402 — sem saldo/créditos
PermissionError 403 — sem permissão (ex: exige PJ)
NotFoundError 404/410 — sem dados / rota desativada
RateLimitError 429 — limite atingido (getRetryAfterMs)
ServerError 5xx — erro do gateway/provedor
NetworkError / TimeoutError falha antes da resposta

Todo erro expõe getStatus() (HTTP), getErrorCode() (código da API) e getResponse() (corpo completo da resposta).

Retry e observabilidade

Por padrão a SDK refaz a chamada em HTTP 429 e em falhas de conexão (2 tentativas extras, backoff exponencial, respeitando Retry-After). Timeouts e erros de negócio nunca são refeitos — evita duplicar cobranças e envios.

Transporte plugável

O HTTP é feito pelo Guzzle (com fallback para cURL), mas a interface TransportInterface permite trocar a camada inteira (proxy corporativo, outro cliente, mocks de teste):

Ou implemente a sua:

Catálogo gerado

As actions de WhatsApp/Evolution/WhatsMeow e os 210+ tipo de consulta estão disponíveis em constantes geradas do catálogo real da plataforma (composer codegen atualiza):

Endpoint sem método dedicado?

Todo o gateway fica acessível pela porta de saída genérica, já com seus headers de autenticação:

Documentação completa dos endpoints: https://doc.apibrasil.io

Configuração avançada

Opções por requisição (último parâmetro de qualquer método): query, headers, bearerToken, deviceToken, secretKey, timeout, responseType.

Atenção: timeout é em milissegundos (igual à SDK Node), diferente da interface legada, que usa segundos.

Interface legada (ApiBrasil\Service)

Os métodos estáticos Service::WhatsApp(), Service::CEP(), Service::CNPJ() e companhia continuam funcionando exatamente como antes (resposta em stdClass, erros devolvidos no corpo em vez de exceções), mas estão deprecados — prefira o cliente ApiBrasil.

Exemplos da interface legada ### AuthService ### DeviceService ### ServerService / ProfileService / PlanService ### WhatsAppService ### VehiclesService ### CorreiosService / CNPJService / CEPService / DDD / Feriados ### Opções de request (legado) - `timeout` (**segundos**): equivalente ao `--max-time` do curl - `connect_timeout` (segundos): timeout de conexão - `verify` (bool): valida SSL (padrão atual: `false`) - `query` (array): querystring (GET/POST)

Mais informações

https://packagist.org/packages/jhowbhz/apigratis-sdk-php

All versions of apigratis-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8
guzzlehttp/guzzle Version ^7.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jhowbhz/apigratis-sdk-php contains the following files

Loading the files please wait ...