Geral

Protocolo

O SCCI REST implementa APIs com arquitetura REST e dados no formato JSON utilizando HTTP ou HTTPS. Independente do protocolo escolhido, o servidor web pode ser configurado para trafegar os dados com ou sem criptografia. No caso de utilização da criptografia, o sistema que consumirá as APIs deverá implementar a lógica necessária para tratamento das informações.

Parâmetros de entrada

Os parâmetros de entrada das requisições devem ser encaminhados no formato de queryString para métodos do tipo GET e JSON nos outros casos.

Parâmetros de Autenticação

Com exceção das APIs utilizadas para obtenção dos parâmetros de autenticação, toda requisição deve conter os atributos descritos abaixo:

Parâmetros de saída

Em geral, as respostas da API SCCI REST apresentarão a seguinte estrutura:

O objeto dados é utilizado para retornar as informações solicitadas na requisição. Quando há o envio de metadados, utilizados principalmente pela produto SCCI Corpweb, eles são encaminhados no objeto tela. O atributo success retorna true quando a requisição for processada corretamente e false caso contrário. O atributo message contém as mensagens de negócio que podem ocorrer em certos contextos no formato string.