PHPackages robertotcestari/vindi-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. robertotcestari/vindi-php ActiveLibrary[API Development](/categories/api) robertotcestari/vindi-php ========================= SDK Vindi para PHP. 1.2.2(5y ago)03GPL-3.0PHPPHP >=5.5.0 Since Aug 4Pushed 5y agoCompare [ Source](https://github.com/robertotcestari/vindi-php)[ Packagist](https://packagist.org/packages/robertotcestari/vindi-php)[ Docs](https://github.com/vindi/vindi-php)[ RSS](/packages/robertotcestari-vindi-php/feed)WikiDiscussions master Synced today READMEChangelogDependencies (4)Versions (17)Used By (0) [![](https://camo.githubusercontent.com/dda556628f51b7dd545f8d87df60ef0906b591f34b4a08643a33761e320290e9/68747470733a2f2f76696e64692d626c6f672e73332e616d617a6f6e6177732e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031372f31302f6c6f676f2d76696e64692d312e706e67)](https://camo.githubusercontent.com/dda556628f51b7dd545f8d87df60ef0906b591f34b4a08643a33761e320290e9/68747470733a2f2f76696e64692d626c6f672e73332e616d617a6f6e6177732e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031372f31302f6c6f676f2d76696e64692d312e706e67) Vindi - SDK PHP =============== [](#vindi---sdk-php) [![Licença do Software](https://camo.githubusercontent.com/6b8d7ad7a3702389f74a27a2f5b0ab9e9b7774aee6b03ce273edce1096f90ac8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d47504c76332d626c75652e737667)](LICENSE)[![Última Versão no Packagist](https://camo.githubusercontent.com/5bf06b6167f4a444bfb475ffac4d3e568290aca2a1b2a5fde3c434dde0cb543d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f76696e64692f76696e64692d7068702e737667)](https://packagist.org/packages/vindi/vindi-php)[![Status de Build](https://camo.githubusercontent.com/fa48c75775be607bc4d8a45c5a89881c63d487a46afff604d74e98c155db7737/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f76696e64692f76696e64692d7068702f6d61737465722e737667)](https://travis-ci.org/vindi/vindi-php)[![Status de Coverage](https://camo.githubusercontent.com/e04ff899163934554f4d47d863c9b1c91806292f3fa711ac1cd874058302d718/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f76696e64692f76696e64692d7068702e737667)](https://scrutinizer-ci.com/g/vindi/vindi-php/code-structure)[![Nota de Qualidade](https://camo.githubusercontent.com/e9ea75e41749b6c484512161ec479386cd3ff7471ac7112610b419746eda6f98/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f76696e64692f76696e64692d7068702e737667)](https://scrutinizer-ci.com/g/vindi/vindi-php)[![Downloads no Total](https://camo.githubusercontent.com/f9ee3e5d0e60f34ac1dd0e6949311f84550009b583703f671199d822320ba0ac/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f76696e64692f76696e64692d7068702e737667)](https://packagist.org/packages/vindi/vindi-php) Descrição ========= [](#descrição) Este pacote consiste em um SDK em PHP para a [API de Recorrência](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644-Introdu%C3%A7%C3%A3o-%C3%A0-API-de-Recorr%C3%AAncia) da [Vindi](https://www.vindi.com.br). Requisitos ========== [](#requisitos) - PHP versão **5.6.x** ou superior. - cURL habilitado para o PHP. - Certificado SSL. - Conta ativa na [Vindi](https://www.vindi.com.br "Vindi"). Instalação ========== [](#instalação) Via Composer ``` composer require vindi/vindi-php ``` Métodos de Autenticação ======================= [](#métodos-de-autenticação) Variável de ambiente -------------------- [](#variável-de-ambiente) > Esse método de autenticação utiliza-se de inserção de variáveis de ambiente. ``` require __DIR__.'/vendor/autoload.php'; // Coloca a chave da Vindi (VINDI_API_KEY) na variável de ambiente do PHP. putenv('VINDI_API_KEY=SUA_CHAVE_DA_API'); // Coloca a chave da Vindi (VINDI_API_URI) na variável de ambiente do PHP. putenv('VINDI_API_URI=https://sandbox-app.vindi.com.br/api/v1/'); // Instancia o serviço de Customers (Clientes) $customerService = new Vindi\Customer; ``` Argumento de instância ---------------------- [](#argumento-de-instância) > Esse método de autenticação utiliza-se de inserção de um *array* como argumento na primeira instância de uma classe *filha* de Resource, **sendo ignorada uma nova tentativa de inserir o argumento em uma outra instância.** ``` require __DIR__.'/vendor/autoload.php'; // Declara em um array os valores de VINDI_API_KEY e VINDI_API_URI $arguments = array( 'VINDI_API_KEY' => 'SUA_CHAVE_DA_API', 'VINDI_API_URI' => 'https://sandbox-app.vindi.com.br/api/v1/' ); // Instancia o serviço de Customers (Clientes) com o array contendo VINDI_API_KEY e VINDI_API_URI $customerService = new Vindi\Customer($arguments); ``` Exemplo de implementação ------------------------ [](#exemplo-de-implementação) > Exemplo de código após autenticação (uma das duas formas existentes descritas acima), seguindo a sequência de instanciação de Customer. ``` // Cria um novo cliente: $customer = $customerService->create([ 'name' => 'Teste da Silva', 'email' => 'contato@vindi.com.br', ]); echo "Novo cliente criado com o id '{$customer->id}'."; // Busca todos os clientes, ordenando pelo campo 'created_at' descendente. $customers = $customerService->all([ 'sort_by' => 'created_at', 'sort_order' => 'desc' ]); // Para cada cliente da array de clientes foreach ($customers as $customer) { $customerService->update($customer->id, [ 'notes' => 'Este cliente foi atualizado pelo SDK PHP.', ]); echo "O cliente '{$customer->name}' foi atualizado!"; } // Instancia o serviço de Product que não requer argumentos, pois já foi configurado em Customer ou foi configurado nas variáveis de ambiente. $productService = new Vindi\Product; // Cria um novo produto: $product = $productService->create([ 'name' => 'Teste de Produto', 'pricing_schema' => [ 'price' => 150, 'schema_type' => 'flat', ] ]); echo "Novo produto criado com o id '{$product->id}'."; ``` Para mais detalhes sobre quais serviços existem, quais campos enviar e demais informações, [verifique nossa página interativa de uso da API](http://vindi.github.io/api-docs/dist/). **Response:**Caso precise de mais detalhes sobre a resposta de cada request, utilize o método `getLastResponse`. Se nenhum request foi efetuado anteriormente, este método retornará `NULL`. ``` // Retorna os dados da última resposta recebida dos servidores da Vindi $lastResponse = $customerService->getLastResponse(); // Retorna o corpo da requisição $body = (string) $customerService->getLastResponse()->getBody(); // Retorna o HTTP Status Code $lastResponse->getStatusCode(); // Retorna o todos os headers $lastResponse->getHeaders(); // Retorna um único header $lastResponse->getHeader('Header-Name'); ``` Webhooks -------- [](#webhooks) Este pacote torna possível a interpretação dos [webhooks enviados pela Vindi](http://atendimento.vindi.com.br/hc/pt-br/articles/203305800-Webhooks). Para tal, disponibilize uma URL/rota que será acessível pela web e nela utilize a classe `Vindi\WebhookHandler`para a interpretação dos eventos: ``` require __DIR__.'/vendor/autoload.php'; // Instancia o objeto que irá lidar com os Webhooks. $webhookHandler = new Vindi\WebhookHandler(); // Pega o evento interpretado pelo objeto. $event = $webhookHandler->handle(); // Decide a ação com base no evento switch ($event->type) { case 'subscription_canceled': // Lidar com o evento de Assinatura cancelada. break; case 'subscription_created': // Lidar com o evento de Assinatura efetuada break; case 'charge_rejected': // Lidar com o evento de Cobrança rejeitada break; case 'bill_created': // Lidar com o evento de Fatura emitida break; case 'bill_paid': // Lidar com o evento de Fatura paga break; case 'period_created': // Lidar com o evento de Período criado break; case 'test': // Lidar com o evento de Teste da URL break; default: // Lidar com falhas e eventos novos ou desconhecidos break; } ``` Dúvidas ------- [](#dúvidas) Caso necessite de informações sobre a plataforma ou API, por favor acesse o [Atendimento Vindi](http://atendimento.vindi.com.br/hc/pt-br). Contribuindo ------------ [](#contribuindo) Por favor, leia o arquivo [CONTRIBUTING.md](CONTRIBUTING.md). Caso tenha alguma sugestão ou bug para reportar, por favor nos comunique através das [issues](./issues). Segurança --------- [](#segurança) Se você descobrir qualquer questão relacionada a segurança, por favor, envie um e-mail para ao invés de utilizar os issues. Changelog --------- [](#changelog) Todas as informações sobre cada release podem ser consultadas em [CHANGELOG.md](CHANGELOG.md). Créditos -------- [](#créditos) - [Vindi](https://github.com/vindi) - [Todos os Contribuidores](../../contributors) Licença ------- [](#licença) GNU GPLv3. Por favor, veja o [Arquivo de Licença](license.txt) para mais informações. ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity3 Limited adoption so far Community16 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~135 days Recently: every ~236 days Total 15 Last Release 2032d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/47b7ce42a6a86b2e36645d2be93509ebf1a89b84fb61ac400ee9533bdefe2ec8?d=identicon)[robertotcestari](/maintainers/robertotcestari) --- Top Contributors [![ravanscafi](https://avatars.githubusercontent.com/u/6104262?v=4)](https://github.com/ravanscafi "ravanscafi (15 commits)")[![talesgalvao](https://avatars.githubusercontent.com/u/2091135?v=4)](https://github.com/talesgalvao "talesgalvao (10 commits)")[![lyoncesar](https://avatars.githubusercontent.com/u/15332442?v=4)](https://github.com/lyoncesar "lyoncesar (8 commits)")[![rtakauti](https://avatars.githubusercontent.com/u/5501740?v=4)](https://github.com/rtakauti "rtakauti (6 commits)")[![st3llaris](https://avatars.githubusercontent.com/u/50752933?v=4)](https://github.com/st3llaris "st3llaris (5 commits)")[![wagner](https://avatars.githubusercontent.com/u/5348?v=4)](https://github.com/wagner "wagner (2 commits)")[![laerte-guimaraes](https://avatars.githubusercontent.com/u/31661772?v=4)](https://github.com/laerte-guimaraes "laerte-guimaraes (2 commits)")[![robertotcestari](https://avatars.githubusercontent.com/u/14261421?v=4)](https://github.com/robertotcestari "robertotcestari (2 commits)")[![vindi-deploy](https://avatars.githubusercontent.com/u/17088614?v=4)](https://github.com/vindi-deploy "vindi-deploy (2 commits)")[![rafaelyanagui](https://avatars.githubusercontent.com/u/6343584?v=4)](https://github.com/rafaelyanagui "rafaelyanagui (1 commits)")[![marcosfreitas](https://avatars.githubusercontent.com/u/1065688?v=4)](https://github.com/marcosfreitas "marcosfreitas (1 commits)")[![havennow](https://avatars.githubusercontent.com/u/2552946?v=4)](https://github.com/havennow "havennow (1 commits)")[![tauanlemos](https://avatars.githubusercontent.com/u/17324672?v=4)](https://github.com/tauanlemos "tauanlemos (1 commits)")[![asagalo](https://avatars.githubusercontent.com/u/2758944?v=4)](https://github.com/asagalo "asagalo (1 commits)")[![rodrigo](https://avatars.githubusercontent.com/u/20539146?v=4)](https://github.com/rodrigo "rodrigo (1 commits)") --- Tags vindivindi-phpvindi-php-sdk ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/robertotcestari-vindi-php/health.svg) ``` [![Health](https://phpackages.com/badges/robertotcestari-vindi-php/health.svg)](https://phpackages.com/packages/robertotcestari-vindi-php) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[vindi/vindi-php SDK Vindi para PHP. 58453.6k](/packages/vindi-vindi-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)