PHPackages                             ispbox2/sdk - 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. ispbox2/sdk

ActiveLiberary

ispbox2/sdk
===========

SDK para acessar recursos da API Duobox

v1.0.5(2y ago)359GPL-3.0-or-laterPHPPHP >=7.4

Since Sep 18Pushed 2y ago1 watchersCompare

[ Source](https://github.com/yantavares031/Ispbox-SDK-PHP)[ Packagist](https://packagist.org/packages/ispbox2/sdk)[ RSS](/packages/ispbox2-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (1)Versions (7)Used By (0)

Ispbox2 SDK / PHP
=================

[](#ispbox2-sdk--php)

[![Latest Stable Version](https://camo.githubusercontent.com/c27f10ed5e2f8b24cad9b50e48812c1e531294e47e11157f98426f7eadfd89e2/687474703a2f2f706f7365722e707567782e6f72672f697370626f78322f73646b2f76)](https://packagist.org/packages/ispbox2/sdk)[![Latest Unstable Version](https://camo.githubusercontent.com/392240d491a6636a452efdadd797477dd176b01bcda15b9dd51158391acfabfc/687474703a2f2f706f7365722e707567782e6f72672f697370626f78322f73646b2f762f756e737461626c65)](https://packagist.org/packages/ispbox2/sdk)

Esta biblioteca prover aos desenvolvedores se comunicar de forma simples e rápida! reduzindo o tempo de integração aos recursos da API do Ispbox. Lembrando que esta SDK foi desenvolvida utilzando como base a API [`ispbox-ajax-requests`](https://github.com/duoboxbr/ispbox-ajax-requests) API

🗒️ Sumário
----------

[](#️-sumário)

- [Instalação](#-instala%C3%A7%C3%A3o)
- [Configurando SDK](#%EF%B8%8F-configurando-sdk)
- [Busca de cliente](#-busca-de-cliente)
    - [Principais propriedades do objeto `Cliente`](#principais-propriedades-do-objeto-cliente)
    - [▷ Método `findOne`](#-m%C3%A9todo-findone)
- [Busca de contratos / Planos contratados](#-busca-de-contratos--planos-contratados)
    - [Principais propriedades do objeto `Contrato`](#principais-propriedades-do-objeto-contrato)
    - [▷ Método `Take`](#-m%C3%A9todo-take)
    - [▷ Método `takeAny`](#-m%C3%A9todo-takeany)
    - [▷ Método `toList`](#-m%C3%A9todo-tolist)
        - [Buscando todos os contratos do cliente por Tipo](#-buscando-todos-os-contratos-do-cliente-por-tipo)
        - [Buscando todos os contratos do cliente por Status](#-buscando-todos-os-contratos-do-cliente-por-status)
- [Busca de Boletos](#-busca-de-boletos)
    - [Principais propriedades do objeto `Boleto`](#principais-propriedades-do-objeto-boleto)
    - [▷ Método `takeAll`](#-m%C3%A9todo-takeall)
        - [Buscando todos os boletos do cliente por Tipo](#-buscando-todos-os-boletos-do-cliente-por-tipo)
        - [Buscando todos os boletos do cliente por Status](#-buscando-todos-os-boletos-do-cliente-por-tipo)

💡 Requisitos
------------

[](#-requisitos)

- PHP 7.4 ou superior
- URL ou IP do sistema (ex: )
- Usuário de acesso do sistema

💻 Instalação
------------

[](#-instalação)

1. Realize o download do [Composer](https://getcomposer.org/doc/00-intro.md) caso não tenha instalado.
2. No diretório raiz do seu projeto, execute em linha de comando

```
$ composer require ispbox2/sdk

```

✅ É isso! O SDK do Ispbox2 foi instalado com sucesso.

🌟 Codando
---------

[](#-codando)

### ⚙️ Configurando SDK

[](#️-configurando-sdk)

```

```

ParâmetroTipoRequisitoDescriçãoExemplo`URL`stringobrigatórioURL Base utilizado no seu ERP Ispbox`https://demo.ispbox.com.br``USER`stringobrigatórioLogin de conta ispbox`admin``PASS`stringobrigatórioSenha de conta Ispbox`password`> **Note** O método `Configure()` internamente faz um teste de conexão validando a `URL` e as `credenciais`. Caso não obtenha êxito no teste, é lançado uma exceção.

🔎 Busca de Cliente
------------------

[](#-busca-de-cliente)

### ▷ Método `findOne()`

[](#-método-findone)

```