🟩API
SubscriptionKey (Chave de Acesso ou Chave de API)
No menu API o cliente tem acesso a chave de acesso da API, que será utilizada para gerenciamento e controle das requisições realizadas via API, também chamada Subscriptionkey. Uma vez que a chave é gerada, ela deve ser incluída no HEADER das requisições para que estas sejam autorizadas.
Nesta tela serão listados os clientes que possuem o serviço ArqAPI vigente no contrato. Se o nome da sua empresa não aparece para gerar a chave entre em contato pelo e-mail: comercial@arquivar.com
Unidade - Cliente: Selecione neste campo o nome da unidade e cliente. Aqui são listados todos os clientes que possuem o serviço ArqAPI vigente no contrato.
Ao selecionar o campo, o botão "Gerar: Par de Chaves" é habilitado na tela.
Chave 1: Quando o cliente ainda não possui chave gerada o campo é apresentado em branco, quando o cliente já tem chave gerada é apresentada a chave 1 gerada automaticamente pelo sistema.
Chave 2: Quando o cliente ainda não possui chave gerada o campo é apresentado em branco, quando o cliente já tem chave gerada é apresentada a chave 2 gerada automaticamente pelo sistema.
Por padrão o sistema vai gerar sempre um "par" de chaves, então o cliente poderá utilizar uma ou outra ou em casos em que a integração ocorre com terceiros, o cliente utiliza uma e o parceiro outra.
Uma vez que a chave é gerada, ela deve ser incluída no HEADER das requisições para que estas sejam autorizadas.
Ao clicar em Gerar: Par de Chaves, é exibida uma mensagem informativa na tela.
Se após regerar as chaves, o usuário não atualizá-las nos parâmetros de pesquisa da integração já existente, as chamadas na API do ArqGED deixarão de funcionar!
Clique no ícone "Visualizar" para mostrar ou ocultar as chaves.
Para regerar o par de chaves, utilize o botão "Gerar: Par de Chaves". Para regerar apenas uma das chaves, utilize o ícone de "Regerar Chave" considerando a chave 1 ou a 2.
Será apresentada na tela a mensagem:
Sempre que a chave for regerada, a anterior é inativada automaticamente, sendo necessário reconfigurar os paramentos da API em que a chave anterior foi incluída.
Como passar a SubscriptionKey
Ao chamar a API na nova rota, será necessário enviar no “Headers” a “SubscriptionKey” conforme figura abaixo:
Última actualización