curl --request DELETE \
--url https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}"
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};
fetch('https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{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.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
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.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}"
req, _ := http.NewRequest("DELETE", 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.delete("https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 215,
"ativo": false
}
}{
"success": false,
"errors": [
{
"code": 68,
"message": "O usuário informado não tem permissão para realizar essa operação."
}
]
}{
"success": false,
"errors": [
{
"code": "B5",
"message": "Usuário e/ou senhas inválidos."
}
]
}{
"success": false,
"errors": [
{
"code": 243,
"message": "Desafio de passageiro não encontrado ou não pertence à central autenticada."
}
]
}{
"success": false,
"errors": [
{
"code": 244,
"message": "O desafio de passageiro já foi encerrado e não pode ser cancelado."
}
]
}Cancelar desafio de passageiro
Cancela um desafio de passageiro da central, com o mesmo efeito do cancelamento no painel: a contagem de corridas para, o progresso e as recompensas já creditadas ficam, e quem já tinha corrida contabilizada e ainda não tinha concluído recebe o push de desafio encerrado.
Regras importantes:
- Vale para qualquer desafio de passageiro da central, criado pela API ou pelo painel.
- Desafio já cancelado responde
200sem disparar o push de novo. Repetir a chamada é seguro. - Desafio já encerrado (passou de
data_hora_fim) não é cancelado e responde409, como no painel: o cancelamento travaria a aprovação das recompensas personalizadas. - Desafio inexistente ou de outra central responde
404.
Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo da bandeira, com a permissão Gerenciar desafios no cargo da central, como o POST /desafios-passageiro.
curl --request DELETE \
--url https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}"
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};
fetch('https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{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.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
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.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}"
req, _ := http.NewRequest("DELETE", 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.delete("https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.taximachine.com.br/api/v2/integracao/desafios-passageiro/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 215,
"ativo": false
}
}{
"success": false,
"errors": [
{
"code": 68,
"message": "O usuário informado não tem permissão para realizar essa operação."
}
]
}{
"success": false,
"errors": [
{
"code": "B5",
"message": "Usuário e/ou senhas inválidos."
}
]
}{
"success": false,
"errors": [
{
"code": 243,
"message": "Desafio de passageiro não encontrado ou não pertence à central autenticada."
}
]
}{
"success": false,
"errors": [
{
"code": 244,
"message": "O desafio de passageiro já foi encerrado e não pode ser cancelado."
}
]
}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
Identificador do desafio, o id devolvido por POST /desafios-passageiro.
215
Response
Desafio cancelado, ou já cancelado
The response is of type object.
