Criando uma instância
Método#
/on-demand#
POST https://api.z-api.io/instances/integrator/on-demand
Conceituação#
Método utilizado para criar uma instância vinculada a sua conta.
Dica
Você não precisa necessáriamente assinar a instância neste momento pois você tem 2 dias de para utilizar como trial.
Atenção
Exclusão de instância
Caso você não realize a assinatura em até 2 dias nosso devops vai automaticamente excluir a maquina conectada a instância. Então em casos de não assinaturas não precisa se preocupar :)
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| name | string | Nome da instância a ser criada |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| deliveryCallbackUrl | string | EndPoint do webhook de mensagens entregues - delivery |
| receivedCallbackUrl | string | EndPoint do webhook de mensagens recebidas - receive |
| disconnectedCallbackUrl | string | EndPoint do webhook de desconexão ou perca de comunicação - disconnected |
| messageStatusCallbackUrl | string | EndPoint do webhook de Status |
Request Body#
Método
POST https://api.z-api.io/instances/integrator/on-demand
Exemplo
Response#
201#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | ID da instância criada |
| token | string | TOKEN da instância criada |
| due | timestamp | Data de validade da instância |
Exemplo
405#
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico.
415#
Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"
Webhook Response#
Link para a response do webhook (ao receber)