Documentação dos web services

O eDocs possui uma solução que permite que a documentação referente aos web services seja gerada automaticamente pelo próprio sistema a partir das atualizações, alterações e implementações realizadas diretamente no código fonte.

Através do caminho no sistema Configurações > Gerais > Integração > Documentação, ou pelo caminho Ajuda > Webservices, é possível acessar a documentação com detalhamento dos métodos, entradas e retornos de cada um dos web services disponíveis de acordo com a versão que o eDocs está sendo executado. Este link fica disponível ao lado de cada parâmetro de configuração de web service, sendo eles:

• Ativar web service de integração
• Ativar web service CODIF
• Ativar web service de impressão
• Ativar web service de download
• Ativar web service de email
• Ativar web service de configuração
• Ativar web service de upload

Ao lado do link de documentação também estarão disponíveis os links para o WSDL (Web Services Description Language) de cada serviço, tornando possível o acesso direto à sua descrição. Com esta informação é possível ter acesso à localização do web service, as operações que ele dispõe e fornece as informações necessárias para que a comunicação entre o sistema e o web service seja possível.

Para acessar esta funcionalidade, é necessário observar os seguintes pontos:

• Se o serviço do eDocs estiver parado, os web services não estarão em execução e consequentemente, o link WSDL não estará disponível para execução;
• Caso o serviço do eDocs esteja em execução mas os web services não, é necessário verificar se ocorreu algum problema ao executar os web services. Para isso, verifique os logs da rotina, resolva qualquer problema que possa ter impedido a inicialização dos web services e reinicie o serviço do eDocs para que os web services fiquem ativos;
• Se o serviço do eDocs estiver instalado em uma máquina diferente do Monitor, o link WSDL não será disponibilizado para utilização. Para verificar mais detalhes sobre esta situação, acesse o link Documentação, no conteúdo apresentado clique no tópico Documentação e acesse URL Serviços;
• Se o eDocs estiver instalado em um ambiente cloud, será necessário entrar em contato com o administrador do ambiente para obter a URL do serviço.

Para acessar a documentação dos web services sem precisar acessar o sistema, basta acessar a documentação da URL dos serviços do eDocs.