Documentação da API de Diplomas Digitais Externos

Toda a comunicação entre o ERP da instituição e o Conector Local é feito via API de Comunicação.

A documentação da API de Comunicação pode ser acessada e testada em tempo real via swagger no próprio Conector Local na URL: http://:/docs/ExternalDocument/.

A porta padrão para a API de comunicação e para acesso a documentação é a 80.

Ela pode ser alterada no arquivo de configuração do docker-compose.

Outra forma de acessar a documentação da API de Comunicação é a partir do arquivo openapiexternal.json que encontra-se anexado na pasta de scripts desta documentação de integração.

Esse arquivo pode ser renderizado em qualquer visualizador de documentação swagger, a exemplo do Swagger Editor.

Além da documentação do Swagger, também é disponibilizada às instituições documentação para uso com o Postman1.