Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apibrasil/apigratis-sdk-php
A ideia desse SDK é otimizar o tempo de código dos usuários auxiliando na integração com a plataforma
https://github.com/apibrasil/apigratis-sdk-php
api api-rest apibrasil apigratis apigratis-sdk-php cnpj cpf php plates sdk vehicles whatsapp
Last synced: 28 days ago
JSON representation
A ideia desse SDK é otimizar o tempo de código dos usuários auxiliando na integração com a plataforma
- Host: GitHub
- URL: https://github.com/apibrasil/apigratis-sdk-php
- Owner: APIBrasil
- License: mit
- Created: 2023-03-11T04:09:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-01T22:11:34.000Z (9 months ago)
- Last Synced: 2024-10-08T19:30:59.945Z (about 1 month ago)
- Topics: api, api-rest, apibrasil, apigratis, apigratis-sdk-php, cnpj, cpf, php, plates, sdk, vehicles, whatsapp
- Language: PHP
- Homepage: http://package.apibrasil.com.br/
- Size: 80.1 KB
- Stars: 15
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# SDK PHP by API BRASIL 🚀
### Conjunto de API, para desenvolvedores
_Transforme seus projetos em soluções inteligentes com nossa API. Com recursos como API do WhatsApp, geolocalização, rastreamento de encomendas, verificação de CPF/CNPJ e mais, você pode criar soluções eficientes e funcionais. Comece agora._
[](https://packagist.org/packages/jhowbhz/apigratis-sdk-php)
[](https://packagist.org/packages/jhowbhz/apigratis-sdk-php)
[](https://php.net/)
## Canais de suporte (Comunidade)
[](https://chat.whatsapp.com/EeAWALQb6Ga5oeTbG7DD2k)
[](https://t.me/apigratisoficial)
## Obtenha suas credenciais
https://apibrasil.com.br
## Instalando pacote com o composer
```bash
composer require jhowbhz/apigratis-sdk-php
```
## Mais informações
https://packagist.org/packages/jhowbhz/apigratis-sdk-php
## Serviços de API disponíveis
| Up | Services available | Description | Free | Beta | Stable |
------|-------------------------------|-------------------|---------| ------------------------- | ------------------------- |
| ✅ | AuthService | API Login e Logout | ✅ | ✅ | ✅ |
| ✅ | ProfileService | API Dados do Usuario | ✅ | ✅ | ✅ |
| ✅ | ServerService | API Lista Servidores | ✅ | ✅ | ✅ |
| ✅ | DeviceService | API Criar, Editar Dispositivos | ✅ | ✅ | ✅ |
| ✅ | WhatsAppService | API WhatsApp | ✅ | ✅ | ✅ |
| ✅ | Receita Data CNPJ | API Dados CNPJ Receita | ✅ | ✅ | ✅ |
| ✅ | Receita Data CPF | API Dados de CPF Serasa | ✅ | ✅ | ✅ |
| ✅ | CorreiosService | API Busca encomendas Correios Brazil | ✅ | ✅ | ✅ |
| ✅ | CEPLocation | API CEP Geolocation + IBGE Brazil | ✅ | ✅ | ✅ |
| ✅ | VehiclesService | API Placa Dados | ✅ | ✅ | ✅ |
| ✅ | FipeService | API Placa FIPE | ✅ | ✅ | ✅ |
| ✅ | DDD Anatel | API Obtem DDD | ✅ | ✅ | ✅ |
| ✅ | FeriadosBrasil | API Feriados Brasil | ✅ | ✅ | ✅ |
## AuthService
Com essa API você poderá obter o Bearer Token
### Para fazer login válido por 1 ano
```php
[
"email" => "[email protected]",
"password" => "123456"
]
]);
var_dump($login);
die;
```
### Com essa API você poderá fazer logout, invalidando o Bearer Token
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
]);
var_dump($logout);
die;
```
## DeviceService
Com essa API é possível criar, editar e deletar dispositivos
### Para criar um dispositivo
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"SecretKey" => "f87eb607-a8cc-43ea-b439.....",
"body" => [
"type" => "cellphone",
"device_name" => "zap1",
"device_key" => "zapzap1",
"device_ip" => "198.29.10.50",
"server_search" => "341d6f36-b888....",
"webhook_wh_message" => "",
"webhook_wh_status" => ""
]
]);
var_dump($store);
die;
```
### Para atualizar um dispositivo
```php
require_once('vendor/autoload.php');
use ApiBrasil\Service;
$update = Service::Device("search", [
"Bearer" => "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"body" => [
"type" => "cellphone",
"search" => "82faab0a-24f4-4b8b-9926-455ea9b3cdb7",
"server_search" => "a2c85262-f830-4b90-a8da-ff67b7a7ed6e",
"device_name" => "zap2",
"device_key" => "zapzap1",
"device_ip" => "198.29.10.50",
"webhook_wh_message" => "",
"webhook_wh_status":""
]
]);
var_dump($update);
die;
```
### Para exibir um dispositivo
```php
require_once('vendor/autoload.php');
use ApiBrasil\Service;
$show = Service::Device("show", [
"Bearer" => "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"method" => "GET",
"body" => [
"search" => "82faab0a-24f4-4b8b-9926-455ea9b3cdb7",
]
]);
var_dump($show);
die;
```
## ServerService
Com essa API é possível listar todos os servidores ativos
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"method" => "GET",
]);
var_dump($servers);
die;
```
## ProfileService
Com essa API é possível listar detalhes do seu perfil
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"method" => "GET",
]);
var_dump($profile);
die;
```
## PlanService
Com essa API é possível listar detalhes do seu plano
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"method" => "GET",
]);
var_dump($plans);
die;
// ou obter o plano do usuario
$plan = Service::Plan("me", [
"Bearer" => "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"method" => "GET",
]);
var_dump($plan);
die;
```
## WhatsAppService
Com essa API é possível enviar mensagens de texto e outros
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"number" => "5531994359434",
"text" => "🟢 Bem vindo ao APIBrasil"
]
]);
var_dump($sendText);
die;
```
## VehiclesService
Com essa API você obtem dados de caracteristicas de um veículo pela placa
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"placa" => "HBM6603",
]
]);
var_dump($dados);
die;
```
## DDDBrasil
API para obter dados de todos os DDD's do Brasil, autorizados pela Anatel
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"ddd" => "31",
]
]);
var_dump($ddd);
die;
```
## FeriadosBrasil
API para obter dados de todos os Feriados nacionais, estadual, municipal e facultativos
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"type" => "facultativo",
"date" => "07/09",
"year" => "2024"
]
]);
var_dump($feriados);
die;
```
## VehiclesService
API para obter dados da Tabela Fipe através da placa
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"placa" => "HBM6603",
]
]);
var_dump($fipe);
die;
```
## CorreiosService
Com essa API você pode obter dados de encomendas dos correios
### API para obter dados de encomendas através do rastreador
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"code" => "NL249695552BR",
]
]);
var_dump($rastreio);
die;
```
### API para obter dados de endereço através de um CEP
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"query" => "32146057",
]
]);
var_dump($address);
die;
```
## CNPJService
Obtenha dados de endereço através de um CNPJ de várias formas
- Lista CNAES
- CPNJ por CEP *
- CNPJ por Estado *
- CNPJ por CNAE
- CNPJ por Capital Social *
- Lista sócios CNPJ *
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"cnpj" => "44.959.669/0001-80",
]
]);
var_dump($cnpj);
die;
```
## CEPService
Com essa API é possível obter dados de coordenadas LAT e LONG e código IBGE apenas com o CEP
- Obtenha Lat e Long por CEP
- Obtenha a lista de Cidades por UF
- Obtenha a lista de Bairros por Cidade
- Obtenha a lista de Estados
```php
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....",
"DeviceToken" => "d019580b-3c8c-40e3-b9a0....",
"body" => [
"cep" => "32146057",
]
]);
var_dump($cep);
die;
```
## Observação
Você poderá obter mais endpoints na documentação de cada api, ou no link https://doc.apibrasil.io