Page tree
Skip to end of metadata
Go to start of metadata

Endereço de Chamada da API

POST /api/statusCustomer/API_TOKEN/API_KEY

Este Ponto de Acesso irá permitir que você altere o status de um Cliente, podendo ativar ou desativar o registro.

Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:

Endereço da API exemplo

POST https://sip.nextbilling.com.br/api/statusCustomer/API_TOKEN/API_KEY

Parâmetros:

  • id: ID do Cliente
  • status: 0 - Desativar | 1 - Ativar

 

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:

Exemplo de chamada a API utilizando cURL
$ curl -X POST -d '{"id": 1, "status": 0}' 'https://sip.nextbilling.com.br/api/statusCustomer/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:

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "customer_id":1,
   "customer_name":"NEXTBILLING RJ 1",
   "old_status":1,
   "new_status":0
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
customer_idID do Cliente
customer_nameNome do Cliente
old_statusStatus antigo do Cliente
new_statusNov Status: 0 - INATIVO | 1 - ATIVO
  • No labels