Enviar notificação in-app para condutores
curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"condutores": [
123,
456,
789
],
"titulo": "Bônus de fim de semana",
"body": "Complete 10 corridas até domingo e ganhe R$ 50 de bônus.",
"url_imagem": "https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png",
"titulo_botao_redirecionamento": "Ver regras",
"link_redirecionamento": "https://central.exemplo.com/campanhas/bonus"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging"
payload = {
"condutores": [123, 456, 789],
"titulo": "Bônus de fim de semana",
"body": "Complete 10 corridas até domingo e ganhe R$ 50 de bônus.",
"url_imagem": "https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png",
"titulo_botao_redirecionamento": "Ver regras",
"link_redirecionamento": "https://central.exemplo.com/campanhas/bonus"
}
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
condutores: [123, 456, 789],
titulo: 'Bônus de fim de semana',
body: JSON.stringify('Complete 10 corridas até domingo e ganhe R$ 50 de bônus.'),
url_imagem: 'https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png',
titulo_botao_redirecionamento: 'Ver regras',
link_redirecionamento: 'https://central.exemplo.com/campanhas/bonus'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging', 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/api/v2/integracao/notificacoes/condutor/in-app-messaging",
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([
'condutores' => [
123,
456,
789
],
'titulo' => 'Bônus de fim de semana',
'body' => 'Complete 10 corridas até domingo e ganhe R$ 50 de bônus.',
'url_imagem' => 'https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png',
'titulo_botao_redirecionamento' => 'Ver regras',
'link_redirecionamento' => 'https://central.exemplo.com/campanhas/bonus'
]),
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/api/v2/integracao/notificacoes/condutor/in-app-messaging"
payload := strings.NewReader("{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "In-App Messaging enviado com sucesso",
"__links": [
{
"rel": "self",
"href": "api/v2/integracao/notificacoes/condutor/in-app-messaging",
"metodo": "post"
},
{
"rel": "enviar-push-condutores",
"href": "api/v2/integracao/notificacoes/condutor/push",
"metodo": "post"
},
{
"rel": "enviar-push-condutor-individual",
"href": "api/v2/integracao/notificacoes/condutor/push/individual",
"metodo": "post"
},
{
"rel": "enviar-in-app-messaging-condutor-individual",
"href": "api/v2/integracao/notificacoes/condutor/in-app-messaging/individual",
"metodo": "post"
}
]
}Notificação
Enviar notificação in-app para condutores
Envia notificação via in-app messaging para uma lista de condutores.
A mensagem é exibida como um modal dentro do aplicativo do condutor, com título, conteúdo, imagem opcional e um botão de redirecionamento opcional. Mensagem recebida com o aplicativo fechado fica guardada e aparece na próxima abertura; enquanto o condutor não a fechar, ela volta a aparecer a cada troca de tela.
Só recebem a notificação os condutores da bandeira da chave de API (ou de suas filiais) que tenham aplicativo com token de notificação registrado. Condutores inexistentes, de outra bandeira ou sem token são ignorados sem erro — o retorno é 404 apenas quando nenhum dos condutores informados pode ser notificado.
POST
/
notificacoes
/
condutor
/
in-app-messaging
Enviar notificação in-app para condutores
curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"condutores": [
123,
456,
789
],
"titulo": "Bônus de fim de semana",
"body": "Complete 10 corridas até domingo e ganhe R$ 50 de bônus.",
"url_imagem": "https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png",
"titulo_botao_redirecionamento": "Ver regras",
"link_redirecionamento": "https://central.exemplo.com/campanhas/bonus"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging"
payload = {
"condutores": [123, 456, 789],
"titulo": "Bônus de fim de semana",
"body": "Complete 10 corridas até domingo e ganhe R$ 50 de bônus.",
"url_imagem": "https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png",
"titulo_botao_redirecionamento": "Ver regras",
"link_redirecionamento": "https://central.exemplo.com/campanhas/bonus"
}
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
condutores: [123, 456, 789],
titulo: 'Bônus de fim de semana',
body: JSON.stringify('Complete 10 corridas até domingo e ganhe R$ 50 de bônus.'),
url_imagem: 'https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png',
titulo_botao_redirecionamento: 'Ver regras',
link_redirecionamento: 'https://central.exemplo.com/campanhas/bonus'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging', 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/api/v2/integracao/notificacoes/condutor/in-app-messaging",
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([
'condutores' => [
123,
456,
789
],
'titulo' => 'Bônus de fim de semana',
'body' => 'Complete 10 corridas até domingo e ganhe R$ 50 de bônus.',
'url_imagem' => 'https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png',
'titulo_botao_redirecionamento' => 'Ver regras',
'link_redirecionamento' => 'https://central.exemplo.com/campanhas/bonus'
]),
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/api/v2/integracao/notificacoes/condutor/in-app-messaging"
payload := strings.NewReader("{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/condutor/in-app-messaging")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"condutores\": [\n 123,\n 456,\n 789\n ],\n \"titulo\": \"Bônus de fim de semana\",\n \"body\": \"Complete 10 corridas até domingo e ganhe R$ 50 de bônus.\",\n \"url_imagem\": \"https://cdn.exemplo.com/campanhas/bonus-fim-de-semana.png\",\n \"titulo_botao_redirecionamento\": \"Ver regras\",\n \"link_redirecionamento\": \"https://central.exemplo.com/campanhas/bonus\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "In-App Messaging enviado com sucesso",
"__links": [
{
"rel": "self",
"href": "api/v2/integracao/notificacoes/condutor/in-app-messaging",
"metodo": "post"
},
{
"rel": "enviar-push-condutores",
"href": "api/v2/integracao/notificacoes/condutor/push",
"metodo": "post"
},
{
"rel": "enviar-push-condutor-individual",
"href": "api/v2/integracao/notificacoes/condutor/push/individual",
"metodo": "post"
},
{
"rel": "enviar-in-app-messaging-condutor-individual",
"href": "api/v2/integracao/notificacoes/condutor/in-app-messaging/individual",
"metodo": "post"
}
]
}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.
Body
application/json
Lista de condutores que receberão a notificação. Deve conter ao menos um item e todos os itens devem ser numéricos. IDs repetidos são considerados uma única vez. Limite máximo de 1000 itens.
Required array length:
1 - 1000 elementsTítulo exibido no topo da mensagem.
Maximum string length:
40Conteúdo principal da mensagem.
Maximum string length:
255URL da imagem exibida no topo da mensagem. Deve ser uma URL válida. Quando omitida, ou quando a imagem não puder ser carregada, o aplicativo exibe a logo da central no lugar.
Maximum string length:
2048Identificador da corrida vinculada à mensagem. Deve ser numérico quando informado. Quando presente, o aplicativo só exibe a mensagem se a corrida for a corrida em andamento do condutor.
Texto do botão de redirecionamento. Obrigatório quando link_redirecionamento for informado; o botão só aparece quando os dois campos vêm preenchidos.
Maximum string length:
20URL aberta ao tocar no botão de redirecionamento. Deve ser uma URL válida. Obrigatório quando titulo_botao_redirecionamento for informado.
Maximum string length:
2048Response
Notificação enviada com sucesso
The response is of type object.