Provedor → POST www.example.customer.com
A callback de provedor é acionada sempre que ocorrer uma ação na plataforma relacionada a um provedor. Nesse caso, enviaremos os dados atuais do provedor e a ação realizada.
Ações que acionam a callback:
| Ação | Action no JSON | Quando ocorre |
|---|---|---|
| Criação | create | Quando um novo provedor é cadastrado. |
| Edição | update | Quando algum dado do provedor é alterado. |
Exemplo de envio:
{
"customer": {
"document": "32704094000176",
"name": "Live Fast Web",
"email": "[email protected]",
"billing_email": "[email protected]",
"support_email": "[email protected]",
"municipal_registration": "34754071",
"state": "RJ",
"city": "Itaguaí",
"zip_code": "23812575",
"address": "Rua Antônia Barbosa Cunha",
"district": "Centro",
"number": "70",
"complement": "Quadra 18",
"telephone": "+552198765-1240",
"telephone2": "+5521981357840",
"total_subscribers_base": 300000,
"plan": "COMUNIDADE ISPs",
"erp": {
"name": "Grupo Voalle",
"connection_data": {
"URL": "URL",
"Token": "Token"
}
},
"hub": "HUB 12",
"status": "active",
"has_unpaid_bills": false,
"customer_success": {
"name": "Zemlak II",
"email": "[email protected]",
"telephone": "+5596937366907"
}
},
"response": "success",
"action": "create",
"is_integration_active": true,
"access_token": "9632947623746c029a51d613fcf4a303f57b99db7ec48f645ed7e76685e6bde9823a66f47",
"token": "c029a51d613fcf4a303f57b99db7ec48f645ed7e76685e6bde9823a66f47",
"partner": "celeti"
}Descrição dos campos da callback:
| Campo | Tipo | Descrição |
|---|---|---|
customer | object | Dados do provedor. |
customer.document | string | CNPJ. |
customer.name | string | Nome. |
customer.email | string | E-mail principal. |
customer.billing_email | string | E-mail utilizado para assuntos relacionados a faturamento. |
customer.support_email | string | E-mail utilizado para assuntos relacionados ao suporte. |
customer.municipal_registration | string | Inscrição municipal. |
customer.state | string | Sigla do estado (UF) onde o provedor está localizado. |
customer.city | string | Cidade onde o provedor está localizado. |
customer.zip_code | string | CEP do endereço. |
customer.address | string | Logradouro do endereço. |
customer.district | string | Bairro do endereço. |
customer.number | string | Número do endereço. |
customer.complement | string|null | Complemento do endereço, quando houver. |
customer.telephone | string | Telefone principal do cliente. |
customer.telephone2 | string|null | Telefone secundário do cliente, quando houver. |
customer.total_subscribers_base | integer | Quantidade total aproximada de assinantes que fazem parte da base do provedor. |
customer.plan | string | Plano contratado. |
customer.erp | object | Informações sobre o ERP utilizado, quando aplicável. |
customer.erp.name | string | Nome do ERP. |
customer.erp.connection_data | object | Dados necessários para estabelecer a conexão com o ERP. Os campos presentes nesse objeto variam conforme o ERP utilizado. |
customer.hub | string | Identificação do Hub associado ao provedor, quando aplicável. |
customer.status | string | Status atual. |
customer.has_unpaid_bills | boolean | Indica se o provedor possui faturas em aberto. |
customer.customer_success | object | Dados do Sucesso do cliente responsável pelo provedor. |
customer.customer_success.name | string | Nome do responsável. |
customer.customer_success.email | string | E-mail do responsável. |
customer.customer_succes.telephone | string | Telefone do responsável. |
response | string | Indica o resultado da operação. |
action | string | Indica a ação realizada. |
is_integration_active | boolean | Indica se a integração do cliente está ativa. |
access_token | string | Access token, para autenticação na API, associado ao provedor. |
token | string | Token que deve ser utilizado no processo de autenticação da callback. |
partner | string | Identificação do parceiro (nossa identificação - celeti). |
Updated 1 day ago
Did this page help you?