Docs - Serviço de acesso externo - GEDWeb

Introdução

Este é o serviço responsável pela geração do Token para autenticação do GEDWeb (SSO – Single Sign-On).

Credenciais de acesso

Para acesso ao serviço, é preciso informar as credenciais por meio do header "Authorization". A composição do header, será feita da seguinte maneira:

Authorization: <TIPO_DE_AUTENTICACAO> <IDENTIFICADOR_1:IDENTIFICADOR_2>

Tipo de Autenticação: Para todas as funções do serviço, utilizaremos como padrão o método "Basic". Este método exige que os identificadores 1 e 2 sejam convertidos em Base 64.

Identificadores 1 e 2: Estes identificadores serão informados para cada função do serviço oferecido.

Exemplo:

Adotaremos o IDENTIFICADOR_1 como 999999 e IDENTIFICADOR_2 como chaveDeAcesso que, convertidos em Base 64, resultarão no seguinte valor: OTk5OTk5OmNoYXZlRGVBY2Vzc28=

Com resultado, criaremos um header da seguinte forma:

Authorization: Basic OTk5OTk5OmNoYXZlRGVBY2Vzc28=

Formato de retorno

Todas as funções do serviço possibilitam o retorno em dois formatos: XML e JSON. Para que o formato desejado seja retornado, é obrigatório que seja informado o header "Accept".

Exemplos:

Para retorno em XML

Accept: application/xml

Accept: text/xml

Para retorno em JSON

Accept: application/json

Accept: text/json

Considerações finais

Para o uso dos serviços, os headers "Authorization" e "Accept" são parâmetros obrigatórios. Caso não seja informado algum parâmetro ou se a construção do header não estiver conforme documentação acima, será apresentado o erro HTTP 400 - Bad Request.