Enviar notificação in-app
curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/in-app-messaging \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"passageiros": [
123,
456
],
"titulo": "Motorista a caminho",
"body": "Acompanhe a solicitação pelo aplicativo.",
"url_imagem": "https://cdn.exemplo.com/notificacoes/motorista.png",
"solicitacao_id": 98765,
"titulo_botao_redirecionamento": "Acompanhar",
"link_redirecionamento": "app://solicitacoes/98765"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/in-app-messaging"
payload = {
"passageiros": [123, 456],
"titulo": "Motorista a caminho",
"body": "Acompanhe a solicitação pelo aplicativo.",
"url_imagem": "https://cdn.exemplo.com/notificacoes/motorista.png",
"solicitacao_id": 98765,
"titulo_botao_redirecionamento": "Acompanhar",
"link_redirecionamento": "app://solicitacoes/98765"
}
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({
passageiros: [123, 456],
titulo: 'Motorista a caminho',
body: JSON.stringify('Acompanhe a solicitação pelo aplicativo.'),
url_imagem: 'https://cdn.exemplo.com/notificacoes/motorista.png',
solicitacao_id: 98765,
titulo_botao_redirecionamento: 'Acompanhar',
link_redirecionamento: 'app://solicitacoes/98765'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/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/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([
'passageiros' => [
123,
456
],
'titulo' => 'Motorista a caminho',
'body' => 'Acompanhe a solicitação pelo aplicativo.',
'url_imagem' => 'https://cdn.exemplo.com/notificacoes/motorista.png',
'solicitacao_id' => 98765,
'titulo_botao_redirecionamento' => 'Acompanhar',
'link_redirecionamento' => 'app://solicitacoes/98765'
]),
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/in-app-messaging"
payload := strings.NewReader("{\n \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\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/in-app-messaging")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/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 \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "OK"
},
"message": "Notificação enviada com sucesso."
}Notificação
Enviar notificação in-app
Envia notificação via in-app messaging para uma lista de passageiros.
POST
/
notificacoes
/
in-app-messaging
Enviar notificação in-app
curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/in-app-messaging \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"passageiros": [
123,
456
],
"titulo": "Motorista a caminho",
"body": "Acompanhe a solicitação pelo aplicativo.",
"url_imagem": "https://cdn.exemplo.com/notificacoes/motorista.png",
"solicitacao_id": 98765,
"titulo_botao_redirecionamento": "Acompanhar",
"link_redirecionamento": "app://solicitacoes/98765"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/in-app-messaging"
payload = {
"passageiros": [123, 456],
"titulo": "Motorista a caminho",
"body": "Acompanhe a solicitação pelo aplicativo.",
"url_imagem": "https://cdn.exemplo.com/notificacoes/motorista.png",
"solicitacao_id": 98765,
"titulo_botao_redirecionamento": "Acompanhar",
"link_redirecionamento": "app://solicitacoes/98765"
}
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({
passageiros: [123, 456],
titulo: 'Motorista a caminho',
body: JSON.stringify('Acompanhe a solicitação pelo aplicativo.'),
url_imagem: 'https://cdn.exemplo.com/notificacoes/motorista.png',
solicitacao_id: 98765,
titulo_botao_redirecionamento: 'Acompanhar',
link_redirecionamento: 'app://solicitacoes/98765'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/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/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([
'passageiros' => [
123,
456
],
'titulo' => 'Motorista a caminho',
'body' => 'Acompanhe a solicitação pelo aplicativo.',
'url_imagem' => 'https://cdn.exemplo.com/notificacoes/motorista.png',
'solicitacao_id' => 98765,
'titulo_botao_redirecionamento' => 'Acompanhar',
'link_redirecionamento' => 'app://solicitacoes/98765'
]),
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/in-app-messaging"
payload := strings.NewReader("{\n \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\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/in-app-messaging")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/notificacoes/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 \"passageiros\": [\n 123,\n 456\n ],\n \"titulo\": \"Motorista a caminho\",\n \"body\": \"Acompanhe a solicitação pelo aplicativo.\",\n \"url_imagem\": \"https://cdn.exemplo.com/notificacoes/motorista.png\",\n \"solicitacao_id\": 98765,\n \"titulo_botao_redirecionamento\": \"Acompanhar\",\n \"link_redirecionamento\": \"app://solicitacoes/98765\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "OK"
},
"message": "Notificação enviada 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.
Body
application/json
Lista de passageiros que receberão a notificação. Deve conter ao menos um item e todos os itens devem ser numéricos. Limite máximo de 1000 itens.
Required array length:
1 - 1000 elementsObrigatório. Título da notificação.
Maximum string length:
40Conteúdo principal da notificação.
Maximum string length:
255URL de imagem da notificação.
Identificador da solicitação vinculada. Deve ser numérico quando informado.
Título do botão de redirecionamento.
Maximum string length:
20Link de redirecionamento do botão.
Response
Notificação enviada com sucesso
The response is of type object.
⌘I
