Todos os guias

Equipa e administração

Tokens de API

Permita que programas, scripts e automatizações giram o Sealed Print com um token de API.

Um token de API dá a um programa acesso à API REST do Sealed Print, por exemplo para acompanhar trabalhos, gerir destinos ou ler a fila a partir de um script. Um token atua em nome da pessoa que o criou, no máximo com as permissões desta, e apenas na organização onde foi criado. A referência da API descreve cada endpoint com exemplos.

Requisitos

  • Cada membro pode criar tokens numa sessão do navegador. Os administradores veem e podem revogar todos os tokens da organização.
  • Os tokens gerem e controlam o Sealed Print: trabalhos, origens, destinos e definições. Não podem submeter trabalhos; os programas enviam os documentos para um endpoint de API.
  • Incluído em todos os planos.

Configuração inicial

  1. Abra Definições → Tokens de API e selecione Novo token.
  2. Introduza um Nome que indique para que serve o token, por exemplo «Exportação de faturas da contabilidade».
  3. Escolha as Permissões: Utilizador (as suas próprias origens, destinos e trabalhos), Administrador ou Proprietário, no máximo a sua própria função.
  4. Escolha a Validade: 7, 30 ou 90 dias, 1 ano, uma data personalizada ou sem validade.
  5. Selecione Criar e copie o token. O token só é apresentado agora; guarde-o num local seguro, por exemplo num gestor de palavras-passe.

Envie o token em cada pedido no cabeçalho Authorization: Bearer sp_api_…. Para listar os seus trabalhos:

curl "https://www.sealedprint.com/api/jobs" \
  -H "Authorization: Bearer sp_api_…"

Com o mesmo cabeçalho, o seu programa acompanha um trabalho (GET /api/jobs/{id}), envia-o para outros destinos ou cancela-o.

No dia a dia

  • Última utilização, na lista de tokens, mostra se um programa ainda utiliza o token.
  • Mudar o nome altera o nome; Renovar emite um novo segredo para o mesmo token (o anterior deixa de funcionar de imediato; o nome, as permissões e a validade mantêm-se); Revogar termina-o definitivamente.
  • Mostrar expirados e revogados apresenta os tokens que já não funcionam.

Resolução de problemas

  • HTTP 401: o token está em falta, errado, expirado ou revogado.
  • HTTP 403: as permissões do token não permitem a ação. Não é possível submeter um trabalho com um token (código api_endpoint_required); envie o documento para um endpoint de API.
  • Um token deixa de funcionar de repente: os tokens ficam inválidos quando a pessoa que os criou sai da organização. Crie um novo token com outro membro.
  • O token foi copiado para onde não devia: selecione Renovar ou Revogar de imediato.

Próximos passos