Histórico da Página

Para efetivar a autenticação do usuário junto à API de integração, a aplicação cliente deve, considerando o endereço de instalação da API como localhost, operando em suas portas padrão (80 e 443):

1. Utilizar o verbo POST para a solicitação;
2. Definir o Content Type da requisição como application/x-www-form-urlencoded;
3. Adicionar ao corpo da requisição os campos:
   1. grant_type com valor password;
   2. username com o valor referente ao nome do usuário utilizado para o logon e;
   3. password com o valor referente à senha deste usuário;
4. Enviar a requisição para o endpoint https://localhost/api/tlra/littera/v1/auth.

Como resultado de sucesso, a API devolverá um objeto JSON como o demonstrado abaixo:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJFeHBlZGlcdTAwRTdcdTAwRTNvIGRlIHBhY290ZXMiLCJleHAiOjE3MTQ1MDQyMjIsImlhdCI6MTcxNDI0NTAyMiwiaXNzIjoiTGl0dGVyYSIsInN1YiI6IjAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZiIsIm5ubSI6IkFkbWluaXN0cmFkb3IiLCJuYW0iOiJVc3VcdTAwRTFyaW8gQWRtaW5pc3RyYWRvciJ9.5dWQ0BJHaa9piHP6yoPv57VqI_dO66_MIr7fWt-SYVI",
    "expires_in": 259200,
    "token_type": "Basic",
    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTQ1MDUxMjIsImlzcyI6IkxpdHRlcmEiLCJuYmYiOjE3MTQ1MDM5MjIsInN1YiI6ImFkbWluIn0.xB79G_B6RsnBg_wzDDN-XFRdMzLoY7wAXP2o2Pv1Y4I"
}

Em caso de falha na autenticação, a API retornará um erro 401 - Unauthorized.

Para renovar a autenticação do usuário junto à API de integração, a aplicação cliente deve, considerando o endereço de instalação da API como localhost, operando em suas portas padrão (80 e 443):

1. Utilizar o verbo POST para a solicitação;
2. Definir o Content Type da requisição como application/x-www-form-urlencoded;
3. Adicionar ao corpo da requisição os campos:
   1. grant_type com valor refresh_token e;
   2. refresh_token com o valor referente ao token de renovação de autenticação obtido durante o processo de autenticação;
4. Enviar a requisição para o endpoint https://localhost/api/tlra/littera/v1/auth.

Como resultado de sucesso, a API devolverá um objeto JSON como o demonstrado abaixo:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJFeHBlZGlcdTAwRTdcdTAwRTNvIGRlIHBhY290ZXMiLCJleHAiOjE3MTQ1MDQyMjIsImlhdCI6MTcxNDI0NTAyMiwiaXNzIjoiTGl0dGVyYSIsInN1YiI6IjAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZiIsIm5ubSI6IkFkbWluaXN0cmFkb3IiLCJuYW0iOiJVc3VcdTAwRTFyaW8gQWRtaW5pc3RyYWRvciJ9.5dWQ0BJHaa9piHP6yoPv57VqI_dO66_MIr7fWt-SYVI",
    "expires_in": 259200,
    "token_type": "Basic",
    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTQ1MDUxMjIsImlzcyI6IkxpdHRlcmEiLCJuYmYiOjE3MTQ1MDM5MjIsInN1YiI6ImFkbWluIn0.xB79G_B6RsnBg_wzDDN-XFRdMzLoY7wAXP2o2Pv1Y4I"
}

Em caso de falha na verificação de validade do token fornecido, a API retornará um erro 401 - Unauthorized.

As consultas aos objetos armazenados na base de dados do projeto Littera podem ser efetivadas de duas formas diferentes: por meio de seu identificado único ou por meio de parâmetros fornecidos na Query String adicionada à URL da requisição. Para tanto, a aplicação cliente deve, considerando o endereço de instalação da API como localhost, operando em suas portas padrão (80 e 443):

1. Utilizar o verbo GET para a requisição;
2. Adicionar o cabeçalho Authorization aos cabeçalhos da requisição, contendo como valor "Basic " - sem aspas -, sucedido do valor de token obtido por meio do processo de autenticação, devendo este estar dentro de sua validade e;
3. Utilizar a URL https://localhost/api/tlra/littera/v1/{className} como base para a requisição, onde className refere-se ao nome do objeto a ser consultado, podendo:
   1. Não acrescentar qualquer parâmetro à URL, efetuando uma pesquisa genérica que trará os primeiros 25 registros ativos daquele objeto, ordenados por sua descrição;
   2. Adicionar um identificador único à URL, retornando o objeto completo caso o identificador seja encontrado e;
   3. Adicionar uma Query String à URL, podendo esta conter os campos page, pageSize, active e filter.

Os campos page, pageSize e active são valores escaláveis, podendo ser descritos conforme a seguinte tabela: