MessGEODocs
Obter chave de API

Chaves e âmbitos

Envie a chave no cabeçalho Authorization em cada pedido.

curl https://api.messgeo.com/v1/me -H "Authorization: Bearer mgk_xxxxxxxxxx_your_secret"

Uma chave no endereço é recusada com 401 key_in_query. As chaves são guardadas apenas como hash, por isso não podemos voltar a mostrá-las.

Âmbitos

ÂmbitoPermitePacotes
account:readConta, saldo, utilização, lista de ferramentasTodos
account:writePreferências de emailStarter, Pro
tools:readExecuções anterioresTodos
tools:runExecutar ferramentas, gasta créditosTodos
tools:ordersEncomendas de relatórios premiumTodos
pt:readLer dados do Monitorização de PromptsStarter, Pro
pt:writeCriar e gerir painéis, prompts, concorrentes, definições, ligações de partilhaPro

O que uma chave pode fazer é o que lhe concedeu e o que o seu pacote permite hoje. Se o pacote mudar, a chave acompanha sem qualquer ação.

Validade

Escolha 30, 90 ou 365 dias, ou sem validade. Avisamos antes de uma chave expirar. Uma chave sem uso durante 90 dias fica inativa: reative-a no painel.

Rotação

A rotação cria uma nova chave com as mesmas definições. Pode manter a antiga ativa durante 1 ou 24 horas enquanto muda.

Lista de IP permitidos

Pode limitar uma chave a endereços que indicar. Pedidos de outros endereços devolvem 401 ip_not_allowed.

Teto diário de créditos

Uma chave que executa ferramentas para no seu teto diário. Mantenha-o baixo em tarefas automáticas.

Boas práticas

  • Dê a cada tarefa a sua chave e apenas os âmbitos necessários.
  • Guarde as chaves no servidor, em variáveis de ambiente.
  • Use uma lista de IP em servidores fixos.
  • Revogue de imediato uma chave que possa ter sido exposta. O efeito é instantâneo.
  • Veja a última utilização e o IP mascarado na página da chave.