...
...
...
| Tip |
|---|
| title | Endereço de Chamada da API |
|---|
|
POST /api/manageCredit/API_TOKEN/API_KEY |
Este Ponto de Acesso irá permitir que você realize operações financeiras em um Cliente ou Linha IP, podendo adicionar,
...
retirar ou setar um valor exato.
Esta API mantém o Histórico de Crédito das operações realizadas, mas você poderá informar se quer que essa informação fique ou não visível para o Cliente.
Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:
| Info |
|---|
| title | Endereço da API exemplo |
|---|
|
POST https://sip.nextbilling.com.br/api/manageCredit/API_TOKEN/API_KEY
Parâmetros: - type: Nível de Gerenciamento da Operação
- device: Gerenciar saldo de uma Linha
- customer: Gerenciar saldo de um Cliente
- record_id: ID do Cliente ou da Linha IP
- amount: Valor da Operação (Ex: 15.50)
- operation: Tipo de Operação
- debit: Realizar uma retirada de valor no Saldo
- credit: Realizar uma adição de valor no Saldo
- set: Setar um valor exato ao Saldo
- reason: Histórico ou Descrição do Lançamento
- is_hidden: 0 - Histórico visível para o Cliente | 1 - Histórico não fica visível para o Cliente
|
...
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
| Panel |
|---|
| title | Exemplo de chamada a API utilizando cURL |
|---|
|
$ curl -X POST -d '{"type": "customer", "record_id": 3, "amount": 60.50, "operation": "credit", "reason": "Cobrança automática de Linhas", "is_hidden": 0}' --header "Content-Type: application/json" 'https://sip.nextbilling.com.br/api/manageCredit/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| Code Block |
|---|
| language | groovy |
|---|
| theme | Midnight |
|---|
| title | Retorno JSON |
|---|
|
{ |
...
...
...
"new_balance_device": 61.50, |
...
"new_balance_customer": 61.50 |
...
| Campo | Descrição |
|---|
| error | 1 em caso de erro |
|---|
| reason | Descrição caso tenha ocorrido algum erro |
|---|
| new_balance_device | Novo Saldo da Linha IP |
|---|
| new_balance_customer | Nov Saldo do Cliente |
|---|
Obtendo o Relatório dos Lançamentos de Crédito
...
| Tip |
|---|
| title | Endereço de Chamada da API |
|---|
|
GET /api/manageCredit/API_TOKEN/API_KEY(/id_cliente) |
Utilizando HTTP GET neste Ponto de Acesso você poderá obter o Relatório das Operações de Crédito realizadas em um Cliente.
Se os Tokens de Acesso forem no Nível Assinante, não será necessário informar o ID do Cliente, no entanto, se os Tokens forem do Nível Revenda ou Master, será necessário informar o ID do Cliente.
| Info |
|---|
| title | Endereço da API exemplo |
|---|
|
https://sip.nextbilling.com.br/api/manageCredit/API_TOKEN/API_KEY(/id_cliente)?date_ini=2015-03-01&date_end=2015-03-30&start=0&limit=100 Parâmetros: - date_ini: Data Inicial
- date_end: Data Final
- start: Exibir registros a partir dessa contagem
- limit: Limitar de registros a ser retornados pela chamada
|
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
| Panel |
|---|
| title | Exemplo de chamada a API utilizando cURL |
|---|
|
$ curl -X GET 'https://sip.nextbilling.com.br/api/manageCredit/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/3?date_ini=2018-01-01&date_end=2018-02-01' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| Code Block |
|---|
| language | groovy |
|---|
| theme | Midnight |
|---|
| title | Retorno JSON |
|---|
|
{ |
...
...
...
...
...
{
"date":"2018-01-31 18:03:52", |
...
"description":"Compra através do Site - PagSeguro", |
...
"balance_before":"13.25", |
...
...
...
...
...
| Campo | Descrição |
|---|
| error | 1 em caso de erro |
|---|
| reason | Descrição caso tenha ocorrido algum erro |
|---|
| records | Total de Registros encontrados na pesquisa sem a paginação solicitada |
|---|
| data.date | Data do Lançamento |
|---|
| description | Descrição / Histórico do Lançamento |
|---|
| balance_before | Saldo antes da Operação |
|---|
| amount | Valor da Operação |
|---|
| balance_after | Saldo após a Operação |
|---|
| type | 0 - Débito |
|---|
| | 3 - Setar Valor Exato |
| is_hidden | 0 - Histórico visível para o Cliente |
|---|
| | 1 - Sem Histórico dessa operação |