Revoga uma API key

DELETE/v1/api-keys/{id}

Rota de administrador. Usa a sessão do portal em Authorization: Bearer; o TMS não a chama com a chave de API.

Para que serve: revoga uma chave. A partir desse instante, qualquer chamada com ela recebe 401.

Quando chamar: quando a chave vazou, quando alguém que a conhecia saiu da equipe, ou quando a integração antiga foi desligada.

Parâmetros

Cabeçalhos (header)

Authorizationtextoobrigatório
Sessão do administrador no portal: Bearer seguido do token. Rota de administrador; o TMS não a chama com a chave de API.

Caminho (path)

idtexto (uuid)obrigatório

Respostas

204

API key revogada

Erroapplication/problem+json

Erro no formato RFC 9457 (application/problem+json)

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Guia explicado

O que fazer: erros

Status	Quando	O que fazer
`401`	Sessão ausente ou vencida	Entrar de novo
`403`	Não é administrador	Pedir a um administrador
`404`	O `id` não existe nesta transportadora	Conferir o `id` na lista

Observações

revogar é definitivo e seguro de repetir (revogar de novo uma chave já revogada responde 204). Para trocar de chave sem parar a integração, emita a nova, troque no TMS, confirme que funciona e só então revogue a antiga.

Texto completo, com mais exemplos, em API por rota.

Requisição

Produção

https://api.veltrasolution.com

Teste

https://api-teste.veltrasolution.com

curl -X DELETE 'https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001' \
  -H 'Authorization: Bearer SEU_TOKEN_DO_PORTAL'

const resposta = await fetch("https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer SEU_TOKEN_DO_PORTAL",
  },
});

console.log(resposta.status);
console.log(await resposta.text());

import requests

resposta = requests.request(
    "DELETE",
    "https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001",
    headers={
        "Authorization": "Bearer SEU_TOKEN_DO_PORTAL",
    },
    timeout=30,
)

print(resposta.status_code)
print(resposta.text)

<?php
$ch = curl_init('https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer SEU_TOKEN_DO_PORTAL',
    ],
]);

$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
echo $resposta;
curl_close($ch);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Exemplo {
    public static void main(String[] args) throws Exception {
        HttpRequest requisicao = HttpRequest.newBuilder(URI.create("https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001"))
        .header("Authorization", "Bearer SEU_TOKEN_DO_PORTAL")
        .method("DELETE", HttpRequest.BodyPublishers.noBody())
        .build();

        HttpResponse<String> resposta = HttpClient.newHttpClient()
            .send(requisicao, HttpResponse.BodyHandlers.ofString());

        System.out.println(resposta.statusCode());
        System.out.println(resposta.body());
    }
}

using System.Net.Http;
using System.Text;

using var cliente = new HttpClient();
var requisicao = new HttpRequestMessage(new HttpMethod("DELETE"), "https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001");
requisicao.Headers.Add("Authorization", "Bearer SEU_TOKEN_DO_PORTAL");

var resposta = await cliente.SendAsync(requisicao);
Console.WriteLine((int)resposta.StatusCode);
Console.WriteLine(await resposta.Content.ReadAsStringAsync());

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requisicao, err := http.NewRequest("DELETE", "https://api.veltrasolution.com/v1/api-keys/0192f3a4-5b6c-7d8e-9f01-000000000001", nil)
	if err != nil {
		panic(err)
	}
	requisicao.Header.Set("Authorization", "Bearer SEU_TOKEN_DO_PORTAL")

	resposta, err := http.DefaultClient.Do(requisicao)
	if err != nil {
		panic(err)
	}
	defer resposta.Body.Close()

	texto, _ := io.ReadAll(resposta.Body)
	fmt.Println(resposta.StatusCode)
	fmt.Println(string(texto))
}

Troque SUA_CHAVE_AQUI pela sua chave. O servidor de teste tem o mesmo comportamento do de produção.