...
| Tip | ||
|---|---|---|
| ||
/api/getCustomerBalance/API_TOKEN/API_KEY(/id_cliente) |
...
Este Ponto de Acesso irá permitir que você consulte o Saldo de um Cliente. Se estiver utilizando Tokens de Acesso do Nível Master ou Nível Revenda, poderá especificar o ID DO CLIENTE como último parâmetro da URL para obter o Saldo de um Cliente de ID especifico.
Caso essa API seja chamada utilizando os Tokens de Acesso do Nível Assinante, não é necessário informar o ID e será retornado o Saldo do Assinante dono do Token utilizado no momento da chamada.
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 | ||
|---|---|---|
| ||
https://sip.nextbilling.com.br/api/getCustomerBalance/API_TOKEN/API_KEY(/id_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 | ||
|---|---|---|
| ||
$ curl -X GET 'https://sip.nextbilling.com.br/api/getCustomerBalance/API_TOKEN/API_KEY/3' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ |
...
"error":0, |
...
"reason":"OK", |
...
"balance": "77,90", |
...
} |