Download the PHP package ispbox2/sdk without Composer

Ispbox2 SDK / PHP

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 API

🗒️ Sumário

• Instalação
• Configurando SDK
• Busca de cliente
  • Principais propriedades do objeto Cliente
  • ▷ Método findOne
• Busca de contratos / Planos contratados
  • Principais propriedades do objeto Contrato
  • ▷ Método Take
  • ▷ Método takeAny
  • ▷ Método toList
  • Buscando todos os contratos do cliente por Tipo
  • Buscando todos os contratos do cliente por Status
• Busca de Boletos
  • Principais propriedades do objeto Boleto
  • ▷ Método takeAll
  • Buscando todos os boletos do cliente por Tipo
  • Buscando todos os boletos do cliente por Status

💡 Requisitos

• PHP 7.4 ou superior
• URL ou IP do sistema (ex: https://demo2.ispbox.com.br)
• Usuário de acesso do sistema

💻 Instalação

1. Realize o download do Composer caso não tenha instalado.

2. No diretório raiz do seu projeto, execute em linha de comando

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

🌟 Codando

⚙️ Configurando SDK

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

▷ Método findOne()

Note O método findOne() é um método estático de busca que retora um objeto do tipo Cliente se houver registros encontrados, caso contrario retorna um objeto Cliente vazio. Para validar se a busca foi realizada com sucesso, utilize a propriedade exists em caso de true a busca obteve resultado!, para false a busca retornou vazia, logo o cliente não foi encontrado.

Principais propriedades do objeto Cliente

Em caso de Pessoa Física as propriedades são:

Em caso de Pessoa Jurídica as propriedades são:

📝 Busca de Contratos / Planos contratados

Note A Classe Contratos é um objeto de busca que retora contratos (sejam eles de TELEFONIA ou de INTERNET) aderidos por determinado cliente válido, que é requisitado como parametro obrigatório do método Construtor da classe. Para filtrar informações do contrato utilize os métodos em seguida....

Principais propriedades do objeto Contrato

▷ Método Take()

Note O método Take() é um método de busca que retora um objeto do tipo Contrato se houver registros encontrados, caso contrario retorna um objeto Contrato vazio. O método Take() retorna somente um unico registro, por padrão se o segundo paramtro id não for passado... ele sempre retornara o primeiro contrato do cliente de acordo com o tipo escolhido. Porém caso queira retornar um contrato especifico é necessário passar o id do contrato como segundo parametro da função.

▷ Método takeAny()

Note O método takeAny() é um método de busca que retorna um objeto do tipo Contrato somente com base no id informado.

▷ Método toList()

Note O método toList() é um método de busca que retorna um array contendo todos os Contratos do cliente

▷ Buscando todos os contratos do cliente por Tipo

Note Retorna array com todos os contratos sem distinção de status, apenas filtrando pelo tipo do contrato.

▷ Buscando todos os contratos do cliente por Status

Note Retorna array com todos os contratos sem distinção de tipo, apenas filtrando pelo status do contrato.

💲 Busca de Boletos

Note A Classe Boletos é um objeto de busca que retora boletos (sejam eles de Mensalidades ou Avulsos) vinculado á um serviço do cliente, que é requisitado como parametro obrigatório do método Construtor da classe.

Principais propriedades do objeto Boleto

▷ Método takeAll()

Note O método takeAll() é um método de busca que retorna um array contendo todos os Boletos do cliente

▷ Buscando todos os boletos do cliente por Tipo

Note Retorna array com todos os boletos sem distinção de status, apenas filtrando pelo tipo do boleto.

▷ Buscando todos os boletos do cliente por Status

Note Retorna array com todos os boletos sem distinção de tipo, apenas filtrando pelo status do boleto.

Projeto em Desenvolvimento

🏻 License