Chaves de API
As chaves que deixam outro sistema da sua empresa chamar o My Solvers em nome do workspace, sem uma pessoa entrando. Aqui elas são emitidas e revogadas, e "Como usar a API" explica como chamar.
Quem pode usar
Só administradores do workspace veem esta tela e a de "Como usar a API". Não há permissão que dê acesso a ela: uma chave pode carregar permissões, e quem emite chaves poderia se dar qualquer uma.
O que a tela mostra
- Chave
- O nome que a chave recebeu e, embaixo, os quatro últimos caracteres do segredo, para você reconhecer qual é qual. O segredo inteiro nunca mais aparece depois da emissão.
- O que permite
- As permissões da chave, cada uma pelo seu identificador. A chave só alcança as chamadas que essas permissões liberam.
- Expira
- O dia a partir do qual a chave deixa de ser aceita. "nunca" quer dizer que ela vale até ser revogada.
- Criada em
- Quando a chave foi emitida.
- Como usar a API
- A página de referência para quem vai programar a integração: o endereço base, o cabeçalho em que a chave viaja, um exemplo de chamada, a lista das chamadas que uma chave alcança com a permissão exigida por cada uma, e o que cada erro quer dizer.
Campos
Nome
O que vai usar a chave, por exemplo o sistema de faturamento. É por ele que você vai reconhecê-la na lista.
- Obrigatório.
Expira em
O dia em que a chave para de funcionar. Deixe vazio e a chave nunca expira.
- Precisa ser uma data futura.
O que permite
O que o sistema que usa a chave pode fazer. Marque só o que ele precisa: uma chave vazada alcança tudo o que ela permite.
- Pelo menos uma.
Ações
- Nova chave
- Abre o formulário de emissão, com nome, validade e permissões.
- Emitir chave
- Cria a chave e mostra o segredo, uma vez só. Fica desabilitado até haver um nome e pelo menos uma permissão marcada.
- Copiar
- Copia o segredo. Se o navegador não deixar, selecione o texto e copie à mão.
- Já copiei
- Fecha a janela do segredo. Ela não fecha clicando fora, justamente para o segredo não se perder sem querer; depois de fechada, não há como vê-lo de novo.
- Revogar (lixeira)
- Pede confirmação e revoga a chave: tudo que a usa para de funcionar na hora, e ela sai da lista. Não tem volta.
- Como usar a API
- Abre a página de referência da API.
- Baixar o contrato
- Na página "Como usar a API", baixa a descrição completa da API para quem vai programar a integração.
Dúvidas comuns
Não. O segredo só aparece na emissão. Emita uma chave nova, troque no sistema que usava a antiga e revogue a antiga.
A chave não foi aceita: ela pode estar revogada, expirada ou com o segredo copiado errado. A resposta é a mesma nos três casos, de propósito. Confira o segredo ou emita uma chave nova.
A chave foi aceita, mas não tem a permissão que aquela chamada exige. A permissão de uma chave não muda depois da emissão: emita outra com a permissão que faltou.