ObterContraordenacoes

Checklist da informação requerida

• Componente responsável pelo serviço
• Porta de entrada (quem invoca e onde está disponível)
• Porta de saída (por onde "passa"/fluxo)
• Clientes conhecidos (entidades e internos)
• Parâmetros de input
• Parâmetros de output
• equipa responsável

1. Introdução

• Este serviço permite consultar contraordenações rodoviárias junto da Autoridade Nacional de Segurança Rodoviária (ANSR).

• Porta de Entrada : PI- Core.

• Porta de Saída : PI - Core para ANSR.

• Equipa Responsável: Equipa de interoperabilidade e Dados - PI.

2. Autenticação

• Disponibilizado em circuito fechado - Acessos através de VPN, deixando os acessos públicos para serviços que não requerem qualquer autenticação, isto é, disponíveis para serem acedidos por qualquer utilizador;

• Basic Authentication - Os serviços apresentam a necessidade de Basic Authentication (inicialmente era obrigatório, mas, entretanto, tornou-se opcional);

• WS-Addressing - Permite a especificação de um endpoint de referência (tag <TO> do WS-Addressing), o que evita a alteração da rota das mensagens;

• Configurações efetuadas pela Equipa de Interoperabilidade e Dados - PI - A configuração para serviços internos tem de ser efetuada pela Equipa de Interoperabilidade e Dados - PI;

• Uso do Autenticação.gov - O BackOffice é acedido usando credenciais obtidas do Autenticação.gov  em que o nível de autorização depende do papel do utilizador que se está a ligar.

3. Endpoints

• Lista dos endpoints disponíveis na API;

• Exemplos de requisições e respostas para cada endpoint.

4. Parâmetros de Requisição

• Descrição dos parâmetros que podem ser incluídos nas requisições;

• Informação sobre como os parâmetros devem ser formatados.

5. Respostas

• Descrição das respostas que a API pode enviar;

• Informação sobre os códigos de status HTTP que podem ser retornados.

6. Exemplos

• Exemplos de uso da API em diferentes linguagens de programação;

• Exemplos de fluxos de trabalho comuns usando a API.

------------------------------------------------------------------------------------------------------