...
| Tip |
|---|
| title | 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:
| Info |
|---|
| title | 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:
| Panel |
|---|
| title | 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:
| Code Block |
|---|
| language | groovy |
|---|
| theme | Midnight |
|---|
| title | Retorno JSON |
|---|
|
{ |
...
...
...
...
"customer_name":"NEXTBILLING RJ 1", |
...
...
...
| Campo | Descrição |
|---|
| error | 1 em caso de erro |
|---|
| reason | Descrição caso tenha ocorrido algum erro |
|---|
| customer_id | ID do Cliente |
|---|
| customer_name | Nome do Cliente |
|---|
| old_status | Status antigo do Cliente |
|---|
| new_status | Nov Status: 0 - INATIVO |
|---|