ezWSI 2.0

Documentação – API de Integração

Nota: A porta padrão de acesso é a 8088, e é exposta somente em interfaces locais. Os métodos descritos nesta documentação são acessados através da master “redbox”. A URL para acesso deve ser, portanto, no padrão http://ip_do_servidor:8088/redbox/metodo.

O método de postagem deve ser POST ou GET. Todos os parâmetros devem ser enviados, exceto os marcados como opcionais.

NOVO: As requisições aos métodos expostos precisam ser autenticadas com o padrão HTTP Auth. O usuário e senha de acesso podem ser configurados na interface de administração.

O retorno de todos os métodos são em formato JSON, XML ou string serializada. Por padrão o sistema retorna uma string no formato JSON. O método format (sem parâmetros) retorna o tipo de formato atual do sistema, como uma string (exemplo: json).

Todos os retornos contém a informação “status” com o código de erro ou sucesso da operação, bem como um objeto “result” de tipo variável, de acordo com cada módulo.

Exemplo de retorno em JSON: {“status”: 0, “result”: objeto de retorno }