Adicionar ou editar permissões de uma bandeira
curl --request PUT \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"bandeira": {
"bandeira_id": 402,
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
}
'import requests
url = "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}"
payload = { "bandeira": {
"bandeira_id": 402,
"eventos": ["cadastro_passageiro_app", "estimativa_passageiro_app", "solicitacao_passageiro_app_abertura", "solicitacao_passageiro_app_finalizada"]
} }
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
bandeira: {
bandeira_id: 402,
eventos: [
'cadastro_passageiro_app',
'estimativa_passageiro_app',
'solicitacao_passageiro_app_abertura',
'solicitacao_passageiro_app_finalizada'
]
}
})
};
fetch('https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}', 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-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'bandeira' => [
'bandeira_id' => 402,
'eventos' => [
'cadastro_passageiro_app',
'estimativa_passageiro_app',
'solicitacao_passageiro_app_abertura',
'solicitacao_passageiro_app_finalizada'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}"
payload := strings.NewReader("{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
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.put("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Permissões de engajamento criadas com sucesso."
}Engajamento
Permissões: adicionar ou editar permissões de uma bandeira
Adiciona uma bandeira a um webhook e define as permissões dessa bandeira. Se a bandeira já estiver no grupo, as permissões de eventos dessa bandeira são alteradas. Impede a inclusão de bandeiras já atreladas a outros webhooks. O envio de eventos é alterado em até 5 minutos após a edição.
PUT
/
integracao
/
v1
/
engajamento
/
permissao
/
{id}
Adicionar ou editar permissões de uma bandeira
curl --request PUT \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"bandeira": {
"bandeira_id": 402,
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
}
'import requests
url = "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}"
payload = { "bandeira": {
"bandeira_id": 402,
"eventos": ["cadastro_passageiro_app", "estimativa_passageiro_app", "solicitacao_passageiro_app_abertura", "solicitacao_passageiro_app_finalizada"]
} }
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
bandeira: {
bandeira_id: 402,
eventos: [
'cadastro_passageiro_app',
'estimativa_passageiro_app',
'solicitacao_passageiro_app_abertura',
'solicitacao_passageiro_app_finalizada'
]
}
})
};
fetch('https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}', 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-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'bandeira' => [
'bandeira_id' => 402,
'eventos' => [
'cadastro_passageiro_app',
'estimativa_passageiro_app',
'solicitacao_passageiro_app_abertura',
'solicitacao_passageiro_app_finalizada'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}"
payload := strings.NewReader("{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
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.put("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/permissao/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bandeira\": {\n \"bandeira_id\": 402,\n \"eventos\": [\n \"cadastro_passageiro_app\",\n \"estimativa_passageiro_app\",\n \"solicitacao_passageiro_app_abertura\",\n \"solicitacao_passageiro_app_finalizada\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Permissões de engajamento criadas com sucesso."
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Obrigatório. Sua chave API.
Path Parameters
ID do webhook.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Sucesso
The response is of type object.
⌘I
