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á api.voipmundotelecom.com.br. Nesse caso, o endereço da API seria:
Endereço da API exemplo POST https://suporte.voipmundotelecom.com.br/api/manageCredit/API_TOKEN/API_KEY
Parâmetros:
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:
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir: