Pular para o conteúdo

API pública

Crie uma chave de API e escolha os scopes

Crie a chave no workspace em que ela vai agir, conceda só os scopes de que a integração precisa e guarde como segredo. Uma chave é mostrada uma vez — se sumir, revogue e emita outra em vez de caçar a original.

Passos

  1. Crie a chave dentro do workspace cujos códigos ela vai tocar. Chaves não atravessam workspaces.
  2. Conceda os scopes mais estreitos com que a integração funcione — só leitura se ela só lê.
  3. Copie a chave para o seu cofre de segredos na hora.
  4. Autentique com um token Bearer ou com o header X-Mosaqo-API-Key, conforme o seu cliente.
  5. Restrinja por endereço onde der, e faça rotação num intervalo definido.

Como conferir o resultado

Chame um endpoint de identidade como /me. Ele deve responder com o workspace esperado, o que também confirma onde a chave vale.

O que costuma dar errado

  • Uma chave commitada num repositório ou colada num chat.
  • Uma única chave todo-poderosa compartilhada por todas as integrações.
  • Uma chave criada no workspace errado, que depois devolve 403 em tudo.
Isto resolveu o seu problema?

Isto não ajudou

Escreva para nós com plataforma e versão, os passos que seguiu, o resultado esperado e o workspace ou QR code envolvido. Mascare qualquer segredo antes de anexar algo.

Escrever ao suporte