Criar webhook.
curl --request POST \
--url https://api.staging.parcelemais.com.br/integration/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3,
"credencial": "seu-token-jwt"
}
'import requests
url = "https://api.staging.parcelemais.com.br/integration/v1/webhooks"
payload = {
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3,
"credencial": "seu-token-jwt"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tipo: 3,
url: 'https://parceiro.exemplo.com/webhooks/pedidos',
tipoAutenticacao: 3,
credencial: 'seu-token-jwt'
})
};
fetch('https://api.staging.parcelemais.com.br/integration/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.parcelemais.com.br/integration/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tipo' => 3,
'url' => 'https://parceiro.exemplo.com/webhooks/pedidos',
'tipoAutenticacao' => 3,
'credencial' => 'seu-token-jwt'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.parcelemais.com.br/integration/v1/webhooks"
payload := strings.NewReader("{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.staging.parcelemais.com.br/integration/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.parcelemais.com.br/integration/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}"
response = http.request(request)
puts response.read_body{
"tipo": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"titulo": "Requisição inválida.",
"status": 400,
"detalhe": "O campo 'cpf' é obrigatório.",
"instancia": "/v1/order"
}Webhooks
Criar webhook
Cadastra um webhook para o parceiro identificado automaticamente pelo token de acesso. Cliente e Simulação podem ser configurados, mas seus fluxos de envio ainda estão em roadmap. Atualmente, os disparos estão disponíveis para Pedido.
POST
/
v1
/
webhooks
Criar webhook.
curl --request POST \
--url https://api.staging.parcelemais.com.br/integration/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3,
"credencial": "seu-token-jwt"
}
'import requests
url = "https://api.staging.parcelemais.com.br/integration/v1/webhooks"
payload = {
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3,
"credencial": "seu-token-jwt"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tipo: 3,
url: 'https://parceiro.exemplo.com/webhooks/pedidos',
tipoAutenticacao: 3,
credencial: 'seu-token-jwt'
})
};
fetch('https://api.staging.parcelemais.com.br/integration/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.parcelemais.com.br/integration/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tipo' => 3,
'url' => 'https://parceiro.exemplo.com/webhooks/pedidos',
'tipoAutenticacao' => 3,
'credencial' => 'seu-token-jwt'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.parcelemais.com.br/integration/v1/webhooks"
payload := strings.NewReader("{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.staging.parcelemais.com.br/integration/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.parcelemais.com.br/integration/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tipo\": 3,\n \"url\": \"https://parceiro.exemplo.com/webhooks/pedidos\",\n \"tipoAutenticacao\": 3,\n \"credencial\": \"seu-token-jwt\"\n}"
response = http.request(request)
puts response.read_body{
"tipo": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"titulo": "Requisição inválida.",
"status": 400,
"detalhe": "O campo 'cpf' é obrigatório.",
"instancia": "/v1/order"
}Cria uma configuração de webhook para o parceiro identificado automaticamente pelo token de acesso.
Tipos de webhook
| Valor | Tipo | Disponibilidade |
|---|---|---|
1 | Cliente | 🟡 Em roadmap — pode ser cadastrado, mas ainda não envia notificações. |
2 | Simulação | 🟡 Em roadmap — pode ser cadastrado, mas ainda não envia notificações. |
3 | Pedido | 🟢 Disponível — envia notificações para os eventos de pedido suportados. |
Os tipos Cliente (
1) e Simulação (2) podem ser configurados, mas ainda não enviam notificações. Atualmente, apenas o tipo Pedido (3) está disponível para os eventos suportados.Tipos de autenticação
| Valor | Significado |
|---|---|
1 | Nenhuma — a requisição é enviada sem credencial de autenticação. |
2 | Basic — utiliza a credencial informada para autenticação HTTP Basic. |
3 | JWT — utiliza a credencial informada como token Bearer JWT. |
A credencial é obrigatória para Basic e JWT. Pode existir apenas um webhook de cada tipo por parceiro.
Authorizations
Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação
Body
application/json
1: Cliente (fluxo em roadmap); 2: Simulação (fluxo em roadmap); 3: Pedido (envio disponível).
Available options:
1, 2, 3 URL HTTP ou HTTPS que receberá as notificações.
1: Nenhuma; 2: Basic; 3: JWT.
Available options:
1, 2, 3 Obrigatória para Basic e JWT. Não deve ser enviada quando não houver autenticação.
Response
Webhook criado com sucesso.