🟩URL da API ArqGED

A URL da API ArqGED será alterada!

A URL https://integracao.arquivar.com/ estará disponível somente até 31/03/2025. Desta forma é importante todos que usam a API ArqGED alterarem as chamadas para a nova rota: https://api-rest.arquivar.com/

Na nova rota será necessário além do usuário e senha, enviar também a SubscriptionKey (Chave de Assinatura ou Chave de API). A Chave de API poderá ser gerada por um usuário com as devidas permissões no ArqGED.

A aplicação permitirá ao usuário gerar um par de chaves, elas poderão ser usadas de forma rotacionada, ou seja, a cada chamada o usuário poderá usar uma.

Rota em processo de descontinuidade: https://integracao.arquivar.com/

É necessário que o usuário escolha qual versão do método deseja utilizar. Alguns métodos já possuem mais de uma versão disponível para trabalho.

Antes de acessar os serviços da URL informada, leia as informações deste manual de integração, para garantir a completa compreensão dos requisitos.


Para visualizar a documentação online de API do ArqGED, acesse: https://developers.arquivar.com/

Ao acessar a URL da documentação, é exibida a lista de API's disponíveis, ao clicar em uma das opções, os dados são listados na tela.

No canto esquerdo da tela é exibida a lista dos métodos disponíveis para a API selecionada.

Clicando no método, é exibido do lado direito da tela o seu detalhamento.

Search operations: Utilize para buscar um método da API selecionada na tela.

Group by tag: Utilize para agrupar os métodos da API selecionada.

Try it: Utilize para testar o método.

Clicando na opção "Try it", é aberto no canto direito da tela os campos de parâmentros e headers para preenchimento e teste.

Para usar os métodos, primeiramente será necessário gerar um token de autenticação em https://api-rest.arquivar.com/v1/api/Autenticacao/Login. No método autenticação são informados a “SubscriptionKey” no “Headers” e os dados do Usuário no “Body”, conforme print abaixo:

Com o token retornado pelo método anterior, será possível usar os outros métodos. Então neste caso, na área do “Headers” precisam ser enviados a “SubscriptionKey” e token de autenticação no formato “Baerer Token” no campo “Authorization”:

Última actualización