Obter solicitações
curl --request GET \
--url https://api-vendas.taximachine.com.br/api/integracao/solicitacao \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"
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/api/integracao/solicitacao', 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/integracao/solicitacao",
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/api/integracao/solicitacao"
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/api/integracao/solicitacao")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")
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,
"response": [
{
"id": "100018001",
"data_hora_solicitacao": "2024-05-02 08:53:42",
"data_hora_solicitacao_utc": "2024-05-02T11:53:42Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83605",
"nome_passageiro": "Rogério Barreto",
"empresa_id": null,
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-02 08:53:49",
"data_hora_pendencia_utc": "2024-05-02T11:53:49Z",
"distancia_coleta_km": null,
"valor_corrida": "7.00",
"condutor_especificado": false,
"com_retorno": false,
"condutor_id": "",
"nome_condutor": "",
"telefone_condutor": "",
"veiculo": "",
"placa_veiculo": "",
"cor_veiculo": null,
"duracao_corrida": "0",
"distancia_percorrida_km": "0",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Rogério Barreto",
"cpf_cliente": "111.222.333-44",
"taxas_cancelamento": null,
"desejado": null,
"paradas": []
},
{
"id": "100018035",
"data_hora_solicitacao": "2024-05-03 09:36:44",
"data_hora_solicitacao_utc": "2024-05-03T12:36:44Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83316",
"nome_passageiro": "Maria Andreia",
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-03 09:36:45",
"data_hora_pendencia_utc": "2024-05-03T12:36:45Z",
"distancia_coleta_km": null,
"valor_corrida": "10.50",
"condutor_especificado": false,
"com_retorno": false,
"condutor_id": "",
"nome_condutor": "",
"telefone_condutor": "",
"veiculo": "",
"placa_veiculo": "",
"cor_veiculo": null,
"duracao_corrida": "0",
"distancia_percorrida_km": "0",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Maria Andreia",
"cpf_cliente": "111.222.333-44",
"taxas_cancelamento": null,
"partida": {
"endereco": "Rua Altaneira",
"complemento": null,
"referencia": null,
"bairro": "Campo Grande",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"lat": "-22.8743056",
"lng": "-43.5626744"
},
"desejado": {
"endereco": "Praça Mauá, 1",
"bairro": "Centro",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"lat": "-22.8992",
"lng": "-43.1804"
},
"paradas": [
{
"id": "320",
"endereco": "Praia do Arpoador",
"complemento": "",
"bairro": "Arpoador",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"lat": "-22.988420900610592",
"lng": "-43.1934916318077",
"ordem": 0,
"numero_pedido": "2"
}
],
"link_acompanhamento_solicitacao": "https://link-acompanhamento-exemplo/solicitacao/acompanhar/OTU2MzE0ODIyOTM1MQ=="
}
]
}Solicitação
Obter solicitações
Ao acionar, são retornadas todas as solicitações da central conforme os parâmetros informados.
O bloco desejado traz o endereço de destino (endereco, bairro, cidade, estado, lat e lng) e vem null quando a solicitação não tem destino definido.
Os campos de data e hora data_hora_solicitacao, data_hora_chegada_local, data_hora_aceite, data_hora_finalizacao, data_hora_cancelamento e data_hora_pendencia continuam no horário da central e no formato AAAA-MM-DD HH:MM:SS. Cada um deles ganhou uma cópia com o sufixo _utc (por exemplo, data_hora_aceite_utc), em ISO 8601 e em UTC (por exemplo, 2023-11-07T05:31:56Z), que vem null quando o original vem null.
Cada solicitação traz também, na raiz, os dados de fechamento que antes só vinham no recibo, em qualquer status, na consulta por id_mch e na listagem:
data_hora_inicio: início da solicitação (nullenquanto não iniciou), em ISO 8601 e em UTC (por exemplo,2023-11-07T05:31:56Z);tipo_pagamento;desconto: percentual de desconto (0.00quando não há);tarifa,id_categoria,categoriaedescricao_categoria;nome_cliente;cpf_cliente: só quando a solicitação não é corporativa (semempresa_id);cnpj_cpf_empresa: só quando a solicitação é corporativa (comempresa_id);codigo_cupomegerador_cupom_id: só quando a solicitação usou cupom.
GET
/
solicitacao
Obter solicitações
curl --request GET \
--url https://api-vendas.taximachine.com.br/api/integracao/solicitacao \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"
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/api/integracao/solicitacao', 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/integracao/solicitacao",
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/api/integracao/solicitacao"
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/api/integracao/solicitacao")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")
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,
"response": [
{
"id": "100018001",
"data_hora_solicitacao": "2024-05-02 08:53:42",
"data_hora_solicitacao_utc": "2024-05-02T11:53:42Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83605",
"nome_passageiro": "Rogério Barreto",
"empresa_id": null,
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-02 08:53:49",
"data_hora_pendencia_utc": "2024-05-02T11:53:49Z",
"distancia_coleta_km": null,
"valor_corrida": "7.00",
"condutor_especificado": false,
"com_retorno": false,
"condutor_id": "",
"nome_condutor": "",
"telefone_condutor": "",
"veiculo": "",
"placa_veiculo": "",
"cor_veiculo": null,
"duracao_corrida": "0",
"distancia_percorrida_km": "0",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Rogério Barreto",
"cpf_cliente": "111.222.333-44",
"taxas_cancelamento": null,
"desejado": null,
"paradas": []
},
{
"id": "100018035",
"data_hora_solicitacao": "2024-05-03 09:36:44",
"data_hora_solicitacao_utc": "2024-05-03T12:36:44Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83316",
"nome_passageiro": "Maria Andreia",
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-03 09:36:45",
"data_hora_pendencia_utc": "2024-05-03T12:36:45Z",
"distancia_coleta_km": null,
"valor_corrida": "10.50",
"condutor_especificado": false,
"com_retorno": false,
"condutor_id": "",
"nome_condutor": "",
"telefone_condutor": "",
"veiculo": "",
"placa_veiculo": "",
"cor_veiculo": null,
"duracao_corrida": "0",
"distancia_percorrida_km": "0",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Maria Andreia",
"cpf_cliente": "111.222.333-44",
"taxas_cancelamento": null,
"partida": {
"endereco": "Rua Altaneira",
"complemento": null,
"referencia": null,
"bairro": "Campo Grande",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"lat": "-22.8743056",
"lng": "-43.5626744"
},
"desejado": {
"endereco": "Praça Mauá, 1",
"bairro": "Centro",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"lat": "-22.8992",
"lng": "-43.1804"
},
"paradas": [
{
"id": "320",
"endereco": "Praia do Arpoador",
"complemento": "",
"bairro": "Arpoador",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"lat": "-22.988420900610592",
"lng": "-43.1934916318077",
"ordem": 0,
"numero_pedido": "2"
}
],
"link_acompanhamento_solicitacao": "https://link-acompanhamento-exemplo/solicitacao/acompanhar/OTU2MzE0ODIyOTM1MQ=="
}
]
}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.
Query Parameters
ID da solicitação. Caso seja informado os outros parâmetros serão ignorados.
Status da solicitação. Caso não seja informado, todos serão considerados. Valores possíveis: Distribuindo (D), Aguardando aceite (G), Pendente (P), Não atendida (N), Aceita (A), Arredores local (A), Cheguei ao local (C), Entrada do passageiro (E), Partida prolongada (O), Alteração de trajeto (T), Em espera (S), Em andamento (E), Parada confirmada (R), Finalizada (F), Cancelada (C), Aguardando pagamento (R).
Available options:
D, G, P, N, A, C, E, O, T, S, R, F ID do taxista que aceitou a solicitação. Caso não seja informado, todos serão considerados.
ID do cliente que aceitou a solicitação. Caso não seja informado, todos serão considerados.
Tipo de pagamento selecionado pelo cliente. Caso não seja informado, todos serão considerado. Valores aceitos: Dinheiro (D), Débito (máquina) (B), Crédito máquina (C), eTicket (T), Voucher (V), Pix (X), Picpay (P), Whatsapp (H), Cartão via app (A), Faturado (F), Pix via app (I), Carteira de créditos (R).
Available options:
D, B, C, T, V, X, P, H, A, F, I, R Data/hora miníma da abertura da solicitação, intervalo máximo de 31 dias em relação ao data_hora_max.
Data/hora máxima da abertura da solicitação, intervalo máximo de 31 dias em relação ao data_hora_min.
ID da empresa que aceitou a corrida.
Permite obter as corridas das filiais, apenas caso o usuário autenticado seja da matriz (1 para verdade 0 para falso).
Available options:
0, 1 Quantidade de solicitações retornadas. O limite padrão é 20 e o máximo é 100.
Required range:
x <= 100Qual início da contagem para o limite. O padrão é 1.
Response
200 - application/json
Sucesso
The response is of type object.