Listar webhooks de engajamento
curl --request GET \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index"
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};
fetch('https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index', 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/index",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"webhooks": [
{
"id": 1,
"headers": {
"X-Cliente-Nome": "nome-exemplo",
"X-Cliente-Chave": "chave-exemplo"
},
"url": "https://www.exemplo.url",
"bandeiras": [
{
"id": 1,
"nome": "Bandeira Exemplo 1",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 2,
"nome": "Bandeira Exemplo 2",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 3,
"nome": "Bandeira Exemplo 3",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
},
{
"id": 2,
"headers": null,
"url": "https://www.exemplo.url2",
"bandeiras": [
{
"id": 6,
"nome": "Bandeira Exemplo 6",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
}
],
"bandeiras_sem_webhook": [
{
"id": 4,
"nome": "Bandeira Exemplo 4"
},
{
"id": 5,
"nome": "Bandeira Exemplo 5"
}
]
}
}Engajamento
Listar webhooks de engajamento
Lista os webhooks de engajamento cadastrados e as bandeiras sem webhook vinculado. Apenas bandeiras do mesmo grupo são consideradas, e somente bandeiras ativas são retornadas na lista de bandeiras sem webhook vinculado.
GET
/
integracao
/
v1
/
engajamento
/
index
Listar webhooks de engajamento
curl --request GET \
--url https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index"
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};
fetch('https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index', 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/index",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/integracao/v1/engajamento/index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"webhooks": [
{
"id": 1,
"headers": {
"X-Cliente-Nome": "nome-exemplo",
"X-Cliente-Chave": "chave-exemplo"
},
"url": "https://www.exemplo.url",
"bandeiras": [
{
"id": 1,
"nome": "Bandeira Exemplo 1",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 2,
"nome": "Bandeira Exemplo 2",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
},
{
"id": 3,
"nome": "Bandeira Exemplo 3",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
},
{
"id": 2,
"headers": null,
"url": "https://www.exemplo.url2",
"bandeiras": [
{
"id": 6,
"nome": "Bandeira Exemplo 6",
"eventos": [
"cadastro_passageiro_app",
"estimativa_passageiro_app",
"solicitacao_passageiro_app_abertura",
"solicitacao_passageiro_app_finalizada"
]
}
]
}
],
"bandeiras_sem_webhook": [
{
"id": 4,
"nome": "Bandeira Exemplo 4"
},
{
"id": 5,
"nome": "Bandeira Exemplo 5"
}
]
}
}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.
Response
200 - application/json
Sucesso
The response is of type object.
⌘I
