PHPackages                             04l3x4ndr3/sdk-iugu - 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. 04l3x4ndr3/sdk-iugu

ActiveLibrary[API Development](/categories/api)

04l3x4ndr3/sdk-iugu
===================

SDK IUGU

0194PHPCI passing

Since Apr 1Pushed 1y ago1 watchersCompare

[ Source](https://github.com/04l3x4ndr3/sdk-iugu)[ Packagist](https://packagist.org/packages/04l3x4ndr3/sdk-iugu)[ RSS](/packages/04l3x4ndr3-sdk-iugu/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

sdk-iugu
========

[](#sdk-iugu)

Kit de Desenvolvimento de Software (SDK) de consumo de APIs da IUGU (Não oficial)

Este SDK encapsula por métodos de classes PHP todas as chamadas da API IUGU. Respeitando as nomenclaturas de parâmetros e estrutura de retorno (response) das chamadas (request).

Os arquivos estão organizados por diretórios conforme abaixo:

```
|+-- Context
|    +-- Customers.php
|    +-- Invoices.php
|    +-- Plans.php
|    +-- Subscriptions.php
|+-- Types
|    +-- Address.php
|    +-- Customer.php
|    +-- Invoice.php
|    +-- InvoiceItem.php
|    +-- Payer.php
|    +-- Plain.php
|    +-- PlainFeature.php
|    +-- SplitRule.php
|    +-- Subscription.php
|    +-- SubscriptionSubitem.php
|+-- Utils
|    +-- HTTPClient.php
+--Configuration.php

```

Instalação Via Compose
----------------------

[](#instalação-via-compose)

Instale o pacote via **composer** utilizando o comando `composer require o4l3x4ndr3/sdk-iugu`.

### Utilizando arquivo .htaccess

[](#utilizando-arquivo-htaccess)

Utilizando o arquivo `.htaccess` da sua aplicação (caso não possua, crie), declare as seguintes variáveis:

```
IUGU_API_KEY

```

### Utilizando a classe Configuration

[](#utilizando-a-classe-configuration)

Também é possível configurar a comunicação com a API através da classe `Configuration`.

```
use O4l3x4ndr3\SdkIugu\Configuration;
use O4l3x4ndr3\SdkIugu\Context\Patient;

# Definindo o token e ambiente...
$config = new Configuration('***api_token***');

```

Testar
------

[](#testar)

Para utilizar os arquivos de exemplos, edite o arquivo `_config.php,` localizado na pasta `samples/context`, e substitua o valor da variável `$api_key` para o valor da sua chave de integração com a api. Após isso, rode o PHP Server na sua máquina local (ou container Docker), utilizando o seguinte comando:

```
php -S localhost:3333 -t samples

```

Contextos da API
----------------

[](#contextos-da-api)

As classes de contextos são constituídas por métodos de consumo da API e possuem suporte a `namespace` do PHP, possível utilizá-los através da palavra-chave `use`, conforme exemplo abaixo:

```
use O4l3x4ndr3\SdkIugu\Context\Patient;

### OBTER DADOS DO PACIENTE ATRAVÉS DO ID ###

# Instanciando a classe
$customer = new Customers();
$customer->getById('ERF78SDF0980...');

# ou através de chamada de forma anônima:
(new Customers())->getById('ERF78SDF0980...');

```

Todas as classes possuem assinaturas que remetem aos métodos documentados no site oficial da API ([https://dev.iugu.com/reference/introdução-a-api](https://https://dev.iugu.com/reference/introdu%C3%A7%C3%A3o-a-api)).

Objetos de Tipos
----------------

[](#objetos-de-tipos)

Os chamados objetos de tipo, são classes que de modelos representados nos contextos de requisição da API e não possuem métodos, apenas propriedades. Um objeto de tipo pode um modelo de dados estruturado e deve ser instanciado e atribuídos os seus respetivos valores de propriedades para assim sejam utilizados nas classes de contextos.

Veja no exemplo a seguir o uso de um objeto de tipo para inserir um novo grupo familiar:

```
use O4l3x4ndr3\SdkIugu\Context\Customer; // Classe do contexto Cliente
...

# Dados do Cliente
$customerData = new Customer('ts@email.com', 'Thiago Silva');

return (new Customers($config))->create($customerData, $arrDependents);

```

Cada tipo possui um construtor, mas outras propriedades (opcionais) também poderão ser declaradas, caso o tipo as possuam.

Contribuição
------------

[](#contribuição)

Caso deseja contribuir para melhorar e manter esse pacote envie e-mail para  e solicite acesso ao repositório informando o seu perfil no github.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance35

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity15

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/f6f1c579663a6dcccdede7e92be304e56493d990834cdb64365575260f5358d7?d=identicon)[04l3x4ndr3](/maintainers/04l3x4ndr3)

---

Top Contributors

[![04l3x4ndr3](https://avatars.githubusercontent.com/u/5231224?v=4)](https://github.com/04l3x4ndr3 "04l3x4ndr3 (11 commits)")

### Embed Badge

![Health badge](/badges/04l3x4ndr3-sdk-iugu/health.svg)

```
[![Health](https://phpackages.com/badges/04l3x4ndr3-sdk-iugu/health.svg)](https://phpackages.com/packages/04l3x4ndr3-sdk-iugu)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)