1. Autenticação

Projeto/Sistema:
Integração API DUIMP

Versão do Template:
1.1

Processo:
Autenticação DUIMP

Versão do Documento:
1.0

Responsável(eis):
Luís Leite

Data:

18/12/2024

1. Introdução

Este processo tem por objetivo descrever a integração com a API do portal Siscomex para busca das informações da DI (Declaração de Importação)

2. Processo

I - Fluxograma Exemplo

Processo	Envolvidos	Dados de Entrada	Dados de Saída
1. Autenticação	Sistema e API GOV	Certificado digital Role-Type	Token, X-CSRF-Token e X-CSRF-Expiration

Especificação Funcional

PROC001 Autenticação:

Regras de Negócio:

1. Ambientes da API:

Ambiente de Validação das Empresas:

Intervenientes privados e públicos: https://val.portalunico.siscomex.gov.br

Ambiente de Produção:

Intervenientes privados e públicos: https://portalunico.siscomex.gov.br

A segurança do portal é baseada em SSL/TLS, sendo obrigatória a utilização de certificados digitais. Ao acionar o serviço de autenticação, será preciso realizar o processo de handshake SSL entre a aplicação cliente e o portal, apresentando um certificado digital válido e reconhecido pelo SERPRO. Após a validação do certificado, o portal consultará a base autorizativa a fim de identificar o perfil do usuário proprietário do certificado digital. O serviço suporta certificados A1 e A3, do padrão ICP-Brasil.

Método	URL
POST	/portal/api/autenticar

2. Deve ser informado no Header o tipo de perfil (Role-Type) como TERCEIROS.

Questões Técnicas:

1. Não serão armazenadas informações sobre o login, sempre que for utilizada alguma função, deve ser refeito o login da empresa.

2. Possíveis retornos da API:

HTTP	Observação
200	Operação realizada com sucesso
201	Recurso criado com sucesso
204	Operação realizada com sucesso. Nenhum conteúdo retornado
400	Requisição mal formatada
400	XML não atende as especificações definidas no XSD (requisições com envio de arquivo XML)
401	Usuário não autenticado ou autenticação inválida
403	Usuário não tem permissão de acesso ao recurso
404	Recurso não encontrado
422	Erro(s) de validação da camada de negócio
500	Erro interno no servidor
503	Serviço indisponível

2. Nos retornos 4xx ou 5xx uma mensagem pode ser retornada especificando a natureza do erro:

Código	Mensagem	Observação
PUCX-ER0101	O cabeçalho 'Role-Type' não está na requisição
PUCX-ER0102	O cabeçalho 'Role-Type' é inválido. Verifique a tabela de domínio no manual de integração.
PLAT-ER2001	Não foi possível identificar um certificado digital válido.	A autenticação SSL/TLS não foi efetuada com sucesso.
PLAT-ER2004	Não foi possível efetuar a consulta de representações do usuário.	Instabilidade no Serviço Único (SUCE). Se possível aguarde alguns instantes e repita a operação. Se o problema persistir entre em contato com o administrador do sistema.
PLAT-ER2002	Ocorreu um erro na autenticação do usuário. Entre em contato com o administrador do sistema. Mensagem de retorno:	Mensagem de erro retornada pelo Serviço Único (SUCE). Em caso de dúvida, entre em contato com o administrador do sistema.
PLAT-ER8001	Não foi possível identificar um certificado digital de equipamento válido.
PLAT-ER8002	O certificado digital não está habilitado no Portal Único do Comércio Exterior.
PLAT-ER8003	A chave de acesso enviada não é válida.
PLAT-ER8004	A integração está desaabilitada temporariamente.

3. Estrutura JSON do retorno com erro:

{
   "message":"O cabeçalho 'Role-Type' não está na requisição.",
   "code":"PUCX-ER0101",
   "tag":"[081454RXF]",
   "status":422,
   "severity":"ERROR"
}