Emitir uma chave de API

Leitura de 3 minutos

Uma chave de API deixa outro sistema (o ERP, um portal de compras) ler ativos e abrir solicitações no Repair sem uma pessoa logada. Cada chave tem um nome, escopos, e um prefixo rk_ que identifica quem a usou.

Antes de começar

Criar pede a ação criar em Integrações; revogar pede excluir; reprocessar um evento pede integrar. De fábrica, só o Administrador tem as três; o Gestor de manutenção consulta.

1. Abra Configurações → Integrações

A aba Integrações, com os cartões Chaves de API, Saída para o Connect e Entrada do Connect

2. Crie a chave

Animação: no cartão Chaves de API, o nome Sistema de compras é digitado, o escopo Abrir solicitações é marcado, a chave é criada e o cartão da chave é fechado

Nome (quem usa) — obrigatório. O campo sugere: ERP Kryia One.
Escopos, em caixas: Ler ativos (marcado por padrão), Criar e atualizar ativos, Abrir solicitações e Ler eventos publicados.

Clique em Criar chave. O cartão Chave criada — aparece uma única vez mostra a chave inteira e explica o uso: “Use em Authorization: Bearer <chave> nas rotas /api/v1/integracao/*. Se perder, revogue e crie outra.” Copie e clique em Fechar.

3. Acompanhe e revogue

Cada chave aparece com o nome, o prefixo rk_…, os escopos e usada em ou nunca usada. Revogar pergunta antes: “Revogar a chave? Quem a usa perde o acesso agora.” Chave revogada ganha o selo Revogada e fica na lista como registro.

4. A conversa com o Connect

O Repair publica eventos (OS encerrada, solicitação aberta, alerta) para o Connect, o barramento dos produtos Kryia, e recebe envelopes de lá.

Saída para o Connect diz se o canal está configurado — “Connect configurado: os eventos são entregues pelo worker.” ou “Connect não configurado: os eventos ficam na fila por até 7 dias; depois viram mortos (reprocessáveis) para a fila não crescer sem fim.” — e lista cada evento com o tipo, a data e o selo pendente, publicado, falhou ou morto, mais o número de tentativas quando houve alguma. Reprocessar devolve à fila um evento que falhou ou morreu, e a tela confirma: Evento devolvido à fila.

Os 7 dias são o prazo de um evento pendente sem Connect configurado. Passado ele, o evento vira morto com o motivo sem destino e deixa de contar como pendente nos indicadores — não some, e continua reprocessável.

O cartão Saída para o Connect, com a frase do canal não configurado e a lista de eventos, cada um com tipo, data e selo

Entrada do Connect lista os envelopes recebidos em /api/v1/webhooks/connect, com o tipo, a origem, a data e o selo aplicado, pendente, ignorado ou falha.

O que acontece depois

Uma solicitação aberta pela chave entra na lista com a origem via Integração e o contato informado, e é triada como qualquer outra. O Repair funciona com o Connect fora do ar: os eventos esperam na fila e saem quando ele voltar — dentro dos 7 dias. Depois disso não se perdem, mas voltam a sair só por Reprocessar.

Problemas comuns

Perdi a chave. Ela não é mostrada de novo. Revogue e crie outra.

A integração recebe 403. A chave não tem o escopo da rota. Confira os escopos na lista; para mudar, crie uma chave nova.

A integração recebe 429. Há um teto de chamadas por minuto por chave. Espace as requisições.

Eventos marcados como morto. O Connect recusou várias vezes. Clique em Reprocessar depois de resolver o motivo no destino.