Método utilizado para criar uma instância vinculada a sua conta.
/on-demand
| Tipo | URL |
POST |
https://api.plugzapi.com.br/instances/integrator/on-demand |
DICA
Você não precisa necessariamente 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 |
|---|---|---|
| sessionName | string | Atributo para alterar o nome da sessão no whatsapp (em aparelhos conectados) |
| deliveryCallbackUrl | string | EndPoint do webhook de mensagens entregues - delivery |
| receivedCallbackUrl | string | EndPoint do webhook de mensagens recebidas - receive |
| receivedAndDeliveryCallbackUrl | string | EndPoint do webhook de mensagens recebidas e enviadas por mim - receive |
| disconnectedCallbackUrl | string | EndPoint do webhook de desconexão ou perca de comunicação - disconnected |
| connectedCallbackUrl | string | EndPoint do webhook de conexão - connected |
| messageStatusCallbackUrl | string | EndPoint do webhook de Status |
Request Body:
| Tipo | URL |
POST |
https://api.plugzapi.com.br/instances/integrator/on-demand |
{
"name": "Instancia PlugMessage - 9292812",
"sessionName": "Testes testes",
"deliveryCallbackUrl": "https://meuwebhook.com.br/delivery",
"receivedCallbackUrl": "https://meuwebhook.com.br/receive",
"disconnectedCallbackUrl": "https://meuwebhook.com.br/disconnected",
"connectedCallbackUrl": "https://meuwebhook.com.br/connected",
"messageStatusCallbackUrl": "https://meuwebhook.com.br/status"
}
Response
200
| 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 |
405
Neste caso certifique que esteja enviando o 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"
Alguns exemplos para auxiliar a implementação
Exemplo em PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.plugzapi.com.br/instances/integrator/on-demand",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"name\": \"Instancia PlugMessage - 9292812\", \"deliveryCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/delivery\", \"receivedCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/receive\", \"disconnectedCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/disconnected\", \"messageStatusCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status\"}",
CURLOPT_HTTPHEADER => array(
"authorization: Bearer SEU-TOKEN-AQUI",
"content-type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo"cURL Error #:" . $err;
} else {
echo $response;
}
Exemplo em Node.js
var http = require("https");
var options = {
"method": "POST",
"hostname": "api.plugzapi.com.br",
"port": null,
"path": "/instances/integrator/on-demand",
"headers": {
"authorization": "Bearer SEU-TOKEN-AQUI"
}
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
name: 'Instancia PlugMessage - 9292812',
deliveryCallbackUrl: 'https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/delivery',
receivedCallbackUrl: 'https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/receive',
disconnectedCallbackUrl: 'https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/disconnected',
messageStatusCallbackUrl: 'https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status'
}));
req.end();
Exemplo em C#
var client = new RestClient("https://api.plugzapi.com.br/instances/integrator/on-demand");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer SEU-TOKEN-AQUI");
request.AddParameter("undefined", "{\"name\": \"Instancia PlugMessage - 9292812\", \"deliveryCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/delivery\", \"receivedCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/receive\", \"disconnectedCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/disconnected\", \"messageStatusCallbackUrl\": \"https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Comentários
0 comentário
Por favor, entre para comentar.