Integrações e chaves de API

As chaves de API permitem que outros sistemas, principalmente o Scolah Compass, trabalhem com o Resources: ler orçamentos e estoque, verificar uma linha antes de um lote ser aprovado, registrar compromissos e despesas, reservar e dar saída no estoque. As chaves pertencem a toda a organização e são gerenciadas em Organização → Integrações por quem tem uma função com a permissão Integrações de escrita (a função Administrador, por padrão).

Criar uma chave

1. Clique em Nova chave de API.
2. Dê um Nome a ela (por exemplo, “Conexão Scolah Compass · orçamento”) e escolha os Escopos: Orçamento, Estoque ou ambos.
3. Clique em Criar chave.
4. Copie a chave agora e salve-a no sistema que vai usá-la. Ela não será mostrada de novo.

Integrações

Renovar uma chave sem interrupção

1. Clique em Renovar na chave e confirme. Uma nova chave é emitida com o mesmo nome, os mesmos escopos e os mesmos espaços de trabalho.
2. Copie a nova chave agora e passe-a para o sistema que usa a antiga.
3. Quando esse sistema tiver feito a troca, clique em Revogar na chave antiga.

As duas chaves funcionam até você revogar a antiga, e a nova chave herda tudo o que a antiga criou: os compromissos em aberto, os pedidos de liberação financeira e as reservas de estoque passam para ela. Não substitua uma chave criando outra: uma chave nova começa sem espaços de trabalho e não enxerga o que a antiga criou. As chaves revogadas continuam listadas por causa do registro de auditoria; os sistemas que as usam param de funcionar imediatamente.

Conectar o Scolah Compass

Quando o Scolah Compass se conecta com uma chave, ele associa uma das agências dele a um espaço de trabalho: um que já existe ou um novo criado por ele (que conta para o limite de espaços de trabalho). A agência conectada aparece em Configurações → Geral → Configurações do Compass. No Scolah Compass Platform, a conexão entre as duas instalações é configurada em Conexões; veja Scolah Compass Resources no catálogo.