[ API ] Gerenciar Franquia de Minutos
Endereço de Chamada da API
GET /api/manageFranchise/API_TOKEN/API_KEY/<customer_id>
Este Ponto de Acesso permite que você obtenha as Franquias de Minutos de um Cliente. Repare que no final da URL, você poderá informar o número 0 ou informar o ID de uma Revenda para listar apenas os Registros da mesma.
Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API para atualizar um registro:
Endereço da API exemplo
POST https://sip.nextbilling.com.br/api/manageFranchise/API_TOKEN/API_KEY/0?id_record=N
O parâmetro id_record será utilizado para sabermos qual registros você está tentando atualizar.
Ponto de acesso para atualizar uma Franquia de Minutos existente:
Parâmetros:
description: Nome/Descrição da Franquia
total_minutes: Total de Minutos da Franquia
additional_minutes: Total de Minutos Adicionais
price: Valor cobrado pela Franquia
status: Status atual do Registro / 0 - Inativo | 1 - Ativo
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API.
Exemplo de chamada a API utilizando cURL para criar uma nova Franquia $ curl -X PUT -d '{"description": "FRANQUIA 10k", "total_minutes": 10000, "additional_minutes": 0, "price": 59.90, "status": 1}' 'https://sip.nextbilling.com.br/api/manageFranchise/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/0'
|
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
A chamada para excluir um registro, é realizado utilizando um HTTP DELETE informando o na query o parâmetro id_record com o ID do registro a ser removido:
Exemplo de chamada a API utilizando cURL $ curl -X DELETE 'https://sip.nextbilling.com.br/api/manageFranchise/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/0?id_record=4'
|
Campo | Descrição |
|---|---|
error | 1 em caso de erro |
reason | Descrição caso tenha ocorrido algum erro |
new_record | ID do novo Registro |