{"id":15474849,"url":"https://github.com/apibrasil/apigratis-sdk-php","last_synced_at":"2025-04-22T14:09:28.474Z","repository":{"id":137995786,"uuid":"612479781","full_name":"APIBrasil/apigratis-sdk-php","owner":"APIBrasil","description":"A ideia desse SDK é otimizar o tempo de código dos usuários auxiliando na integração com a plataforma","archived":false,"fork":false,"pushed_at":"2024-03-01T22:11:34.000Z","size":82,"stargazers_count":18,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-22T14:09:22.144Z","etag":null,"topics":["api","api-rest","apibrasil","apigratis","apigratis-sdk-php","cnpj","cpf","php","plates","sdk","vehicles","whatsapp"],"latest_commit_sha":null,"homepage":"http://package.apibrasil.com.br/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/APIBrasil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":"jhowbhz","otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-03-11T04:09:26.000Z","updated_at":"2025-03-22T02:14:00.000Z","dependencies_parsed_at":"2024-02-13T02:30:39.324Z","dependency_job_id":"f7062eb2-9a68-4e3e-bb33-bbb9d449e54d","html_url":"https://github.com/APIBrasil/apigratis-sdk-php","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIBrasil%2Fapigratis-sdk-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIBrasil%2Fapigratis-sdk-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIBrasil%2Fapigratis-sdk-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIBrasil%2Fapigratis-sdk-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/APIBrasil","download_url":"https://codeload.github.com/APIBrasil/apigratis-sdk-php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250255697,"owners_count":21400410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","apibrasil","apigratis","apigratis-sdk-php","cnpj","cpf","php","plates","sdk","vehicles","whatsapp"],"created_at":"2024-10-02T03:05:13.996Z","updated_at":"2025-04-22T14:09:28.452Z","avatar_url":"https://github.com/APIBrasil.png","language":"PHP","funding_links":["https://issuehunt.io/r/jhowbhz"],"categories":[],"sub_categories":[],"readme":"# SDK PHP \u003csmall\u003e by API BRASIL\u003c/small\u003e  🚀\n### Conjunto de API, para desenvolvedores\n\n_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._\n\n[![latest stable version](https://poser.pugx.org/jhowbhz/apigratis-sdk-php/v/stable.svg)](https://packagist.org/packages/jhowbhz/apigratis-sdk-php)\n[![license mit](https://poser.pugx.org/jhowbhz/apigratis-sdk-php/license.svg)](https://packagist.org/packages/jhowbhz/apigratis-sdk-php)\n\u003ca href=\"https://github.com/APIBrasil/apigratis-sdk-php/issues\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/APIBrasil/apigratis-sdk-php\"\u003e\u003c/a\u003e\n\u003cimg alt=\"GitHub all releases\" src=\"https://img.shields.io/github/downloads/APIBrasil/apigratis-sdk-php/total\"\u003e\n\u003ca href=\"https://github.com/jhowbhz/apigratis-sdk-php/network\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/APIBrasil/apigratis-sdk-php\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/jhowbhz/apigratis-sdk-php/stargazers\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/APIBrasil/apigratis-sdk-php\"\u003e\u003c/a\u003e\n[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)\n\n## Canais de suporte (Comunidade)\n[![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/EeAWALQb6Ga5oeTbG7DD2k)\n[![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/apigratisoficial)\n\n## Obtenha suas credenciais\nhttps://apibrasil.com.br\n\n## Instalando pacote com o composer\n```bash\ncomposer require jhowbhz/apigratis-sdk-php\n```\n\n## Mais informações\nhttps://packagist.org/packages/jhowbhz/apigratis-sdk-php\n\n## Serviços de API disponíveis\n\n| Up  | Services available            | Description       | Free    | Beta        | Stable   |\n------|-------------------------------|-------------------|---------| ------------------------- | ------------------------- |\n| ✅ | AuthService                    | API Login e Logout                      |   ✅   | ✅                   | ✅                   |\n| ✅ | ProfileService                 | API Dados do Usuario                    |   ✅   | ✅                   | ✅                   |\n| ✅ | ServerService                  | API Lista Servidores                    |   ✅   | ✅                   | ✅                   |\n| ✅ | DeviceService                  | API Criar, Editar Dispositivos          |   ✅   | ✅                   | ✅                   |\n| ✅ | WhatsAppService                | API WhatsApp                            |   ✅   | ✅                   | ✅                   |\n| ✅ | Receita Data CNPJ              | API Dados CNPJ Receita                  |   ✅   | ✅                   | ✅                   |\n| ✅ | Receita Data CPF               | API Dados de CPF Serasa                 |   ✅   | ✅                   | ✅                   |\n| ✅ | CorreiosService                | API Busca encomendas Correios Brazil    |   ✅   | ✅                   | ✅                   |\n| ✅ | CEPLocation                    | API CEP Geolocation + IBGE Brazil       |   ✅   | ✅                   | ✅                   |\n| ✅ | VehiclesService                | API Placa Dados                         |   ✅   | ✅                   | ✅                   |\n| ✅ | FipeService                    | API Placa FIPE                          |   ✅   | ✅                   | ✅                   |\n| ✅ | DDD Anatel                     | API Obtem DDD                           |   ✅   | ✅                   | ✅                   |\n| ✅ | FeriadosBrasil                 | API Feriados Brasil                     |   ✅   | ✅                   | ✅                   |\n\n## AuthService\nCom essa API você poderá obter o Bearer Token\n\n### Para fazer login válido por 1 ano\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$login = Service::Auth(\"login\", [\n    \"body\" =\u003e [\n        \"email\" =\u003e \"jhondoe@gmail.com\",\n        \"password\" =\u003e \"123456\"\n    ]\n]);\n\nvar_dump($login);\ndie;\n```\n\n### Com essa API você poderá fazer logout, invalidando o Bearer Token\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$logout = Service::Auth(\"logout\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n]);\n\nvar_dump($logout);\ndie;\n```\n\n## DeviceService\nCom essa API é possível criar, editar e deletar dispositivos\n\n### Para criar um dispositivo\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$store = Service::Device(\"store\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"SecretKey\" =\u003e \"f87eb607-a8cc-43ea-b439.....\",\n    \"body\" =\u003e [\n        \"type\" =\u003e \"cellphone\",\n        \"device_name\" =\u003e \"zap1\",\n        \"device_key\" =\u003e \"zapzap1\",\n        \"device_ip\" =\u003e \"198.29.10.50\",\n        \"server_search\" =\u003e \"341d6f36-b888....\",\n        \"webhook_wh_message\" =\u003e \"\",\n        \"webhook_wh_status\" =\u003e \"\"\n    ]\n]);\n\nvar_dump($store);\ndie;\n```\n\n### Para atualizar um dispositivo\n\n```php\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$update = Service::Device(\"search\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"body\" =\u003e [\n        \"type\" =\u003e \"cellphone\",\n        \"search\" =\u003e \"82faab0a-24f4-4b8b-9926-455ea9b3cdb7\",\n        \"server_search\" =\u003e \"a2c85262-f830-4b90-a8da-ff67b7a7ed6e\",\n        \"device_name\" =\u003e \"zap2\",\n        \"device_key\" =\u003e \"zapzap1\",\n        \"device_ip\" =\u003e \"198.29.10.50\",\n        \"webhook_wh_message\" =\u003e \"\",\n        \"webhook_wh_status\":\"\"\n    ]\n]);\n\nvar_dump($update);\ndie;\n```\n\n### Para exibir um dispositivo\n```php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$show = Service::Device(\"show\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"method\" =\u003e \"GET\",\n    \"body\" =\u003e [\n        \"search\" =\u003e \"82faab0a-24f4-4b8b-9926-455ea9b3cdb7\",\n    ]\n]);\n\nvar_dump($show);\ndie;\n```\n\n## ServerService\nCom essa API é possível listar todos os servidores ativos\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$servers = Service::Server([\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"method\" =\u003e \"GET\",\n]);\n\nvar_dump($servers);\ndie;\n```\n\n## ProfileService\nCom essa API é possível listar detalhes do seu perfil\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$profile = Service::Profile([\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"method\" =\u003e \"GET\",\n]);\n\nvar_dump($profile);\ndie;\n```\n\n## PlanService\nCom essa API é possível listar detalhes do seu plano\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$plans = Service::Plan(\"all\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"method\" =\u003e \"GET\",\n]);\n\nvar_dump($plans);\ndie;\n\n// ou obter o plano do usuario\n$plan = Service::Plan(\"me\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"method\" =\u003e \"GET\",\n]);\n\nvar_dump($plan);\ndie;\n```\n\n## WhatsAppService\nCom essa API é possível enviar mensagens de texto e outros\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$sendText = Service::WhatsApp(\"sendText\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"number\" =\u003e \"5531994359434\",\n        \"text\" =\u003e \"🟢 Bem vindo ao APIBrasil\"\n    ]\n]);\n\nvar_dump($sendText);\ndie;\n```\n\n## VehiclesService\nCom essa API você obtem dados de caracteristicas de um veículo pela placa\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$dados = Service::Vehicles(\"dados\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"placa\" =\u003e \"HBM6603\",\n    ]\n]);\n\nvar_dump($dados);\ndie;\n```\n\n## DDDBrasil\nAPI para obter dados de todos os DDD's do Brasil, autorizados pela Anatel\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$ddd = Service::DDD(\"ddd\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"ddd\" =\u003e \"31\",\n    ]\n]);\n\nvar_dump($ddd);\ndie;\n```\n\n## FeriadosBrasil\nAPI para obter dados de todos os Feriados nacionais, estadual, municipal e facultativos\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$feriados = Service::HoliDays(\"feriados\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"type\" =\u003e \"facultativo\",\n        \"date\" =\u003e \"07/09\",\n        \"year\" =\u003e \"2024\"\n    ]\n]);\n\nvar_dump($feriados);\ndie;\n```\n## VehiclesService\nAPI para obter dados da Tabela Fipe através da placa\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$fipe = Service::Vehicles(\"fipe\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"placa\" =\u003e \"HBM6603\",\n    ]\n]);\n\nvar_dump($fipe);\ndie;\n```\n\n## CorreiosService\nCom essa API você pode obter dados de encomendas dos correios\n\n### API para obter dados de encomendas através do rastreador\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$rastreio = Service::Correios(\"rastreio\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"code\" =\u003e \"NL249695552BR\",\n    ]\n]);\n\nvar_dump($rastreio);\ndie;\n```\n\n### API para obter dados de endereço através de um CEP\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$address = Service::Correios(\"address\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"query\" =\u003e \"32146057\",\n    ]\n]);\n\nvar_dump($address);\ndie;\n\n```\n## CNPJService\nObtenha dados de endereço através de um CNPJ de várias formas\n\n- Lista CNAES\n- CPNJ por CEP *\n- CNPJ por Estado *\n- CNPJ por CNAE\n- CNPJ por Capital Social *\n- Lista sócios CNPJ *\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$cnpj = Service::CNPJ(\"cnpj\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"cnpj\" =\u003e \"44.959.669/0001-80\",\n    ]\n]);\n\nvar_dump($cnpj);\ndie;\n\n```\n\n## CEPService\nCom essa API é possível obter dados de coordenadas LAT e LONG e código IBGE apenas com o CEP\n\n- Obtenha Lat e Long por CEP\n- Obtenha a lista de Cidades por UF\n- Obtenha a lista de Bairros por Cidade\n- Obtenha a lista de Estados\n\n```php\n\u003c?php\n\nrequire_once('vendor/autoload.php');\nuse ApiBrasil\\Service;\n\n$cep = Service::CEP(\"cep\", [\n    \"Bearer\" =\u003e \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.....\",\n    \"DeviceToken\" =\u003e \"d019580b-3c8c-40e3-b9a0....\",\n    \"body\" =\u003e [\n        \"cep\" =\u003e \"32146057\",\n    ]\n]);\n\nvar_dump($cep);\ndie;\n```\n##  Observação\nVocê poderá obter mais endpoints na documentação de cada api, ou no link https://doc.apibrasil.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapibrasil%2Fapigratis-sdk-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapibrasil%2Fapigratis-sdk-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapibrasil%2Fapigratis-sdk-php/lists"}