Ir para o conteĆŗdo

Prévia de documentação apenas para visualização

Esta é uma prévia da documentação do Portal, gerada a partir do branch r67-negro , e o propósito desta pÔgina é simples conferências e revisão pelos departamentos responsÔveis da Decex e RFB. Não é a documentação definitiva e qualquer coisa aqui pode mudar a qualquer momento. A documentação da release atual pode ser sempre acessada em https://docs.portalunico.siscomex.gov.br/ .

Sintia

O Sistema de Trânsito Internacional Aduaneiro (Sintia-BR) integra o Portal Único de Comércio Exterior (Pucomex) possibilita a integração com os países participantes do acordo do Mercosul para a troca de informações sobre o transporte terrestre de cargas. As seguintes naturezas de eventos são suportadas:

  • OFTAI - Geração do MIC-DTA;
  • PATAI - Partida do caminhĆ£o;
  • SATAI - SaĆ­da do caminhĆ£o do paĆ­s (cruzamento da fronteira).

Envio de eventos

O módulo de envios é o responsÔvel por tratar as informações de trânsito originadas no Sistema de Controle de Carga e Trânsito (CCT). As informações são traduzidas para o formato dos sistemas Sintia dos países integrados. Atualmente, o Portal Único envia eventos para os seguintes países:

  • Argentina
  • BolĆ­via
  • Paraguai
  • Uruguai

Importante

Não existem serviços disponíveis na API para uso dos intervenientes privados.

Recepção de eventos

O módulo de recepção trata as informações de trânsito enviadas pelos sistemas Sintia dos países integrados.

Finalidade dos serviƧos

Os serviços disponibilizados nesse módulo são destinados aos países participantes do acordo do Mercosul para a troca de informações sobre o transporte terrestre de cargas.

Habilitação de sistemas

A habilitação do sistema integrado é uma operação de cadastro feita por um usuÔrio administrador do Portal Único de Comércio Exterior.

O time técnico responsÔvel pelo desenvolvimento da integração precisa enviar o certificado digital juntamente com os certificados das autoridades que compõem a cadeia. As autoridades certificadoras podem ser aquelas ancoradas em raízes públicas e amplamente conhecidas, como os fornecedores de certificados digitais que são incluídas em trust stores públicas de navegadores como Mozilla Firefox ou Google Chrome, que possuem um processo rigoroso de auditoria e validação. Adicionalmente, a aplicação aceita certificados assinados por CAs que façam parte de infraestruturas nacionais de chave pública (PKI) estabelecidas e normatizadas, como PKIs governamentais destinadas a garantir a autenticidade e integridade de transações dentro de suas jurisdições.

A aplicação não aceitarÔ certificados emitidos por CAs auto-assinadas, ou que não possuam histórico de conformidade ou verificações públicas. Também não é permitida a habilitação de certificados auto-assinados individuais.

Nesse processo de habilitação serÔ gerado um código identificador de sistema o qual serÔ usado no arquivo de requisição de login.

Ambientes

OBS: o módulo disponível se encontra em fase de homologação

Autenticação

O serviço de autenticação é provido pela plataforma do Portal Único de Comércio Exterior seguindo os seus padrões. A seguir, os passos para autenticação:

1) Gerar o arquivo requisição em formato JSON com a seguinte estrutura (login-request.json):

{
  "system-code": <system_code>
}
Nome Descrição Tipo do dado
system-code Chave de acesso do sistema. string, obrigatório

2) Gerar o CMS (Cryptographic Message Syntax)
O arquivo JSON gerado no passo anterior serÔ usado para geração na mensagem criptografada. Abaixo, o comando para geração manual usando OpenSSL.

openssl cms -sign -in login-request.json -out login-request.json.cms -signer myCertificate.pem -inkey myPrivate.key -nodetach -outform PEM

OBS: Esse comando gera uma saĆ­da em formato PEM contendo o json assinado com a chave privada cuja chave pĆŗblica foi habilitada no cadastro do sistema integrado.

3) Acionar o serviço de autenticação

Endpoint: {host}/portal/api/autenticar/cms
Method: POST
Headers:
- Content-Type: application/json
Body:

{
    "login-request": "<login_request>"
}
Nome Descrição Tipo do dado
login-request Conteúdo do arquvivo CMS (login-request.json.cms) string, obrigatório

OBS: Copiar somente o conteúdo entre as marcações "-----BEGIN CMS-----" e "-----END CMS-----" e remover as quebras de linhas.

Retorno de sucesso (HTTP 200)

Se a autenticação ocorrer com sucesso, o retorno JSON terÔ os seguintes atributos:

Nome Descrição Tipo do dado
authorization jwt com as informaƧƵes do usuƔrio autenticado string
x-csrf-token token de seguranƧa string
x-csrf-expiration data/hora da expiração do token de segurança string data ISO 8601

Retorno de erro (HTTP 4xx ou 5xx)

Em caso de falha, os seguintes atributos serão retornados no objeto JSON:

Nome Descrição Tipo do dado
status indicador de status HTTP int
code o código de erro string
message a mensagem de erro string
tag a tag de rastreio do erro erro string

ServiƧos

A estrutura de dados do XML seguiu o mesmo padrão usado para envios de eventos ao Sintia Argentina. A única diferença estÔ na forma como são enviadas as credenciais de autenticação. Seguindo o padrão do Portal Único de Comércio Exterior, os tokens de segurança devem ser enviados por meio de headers.

Endpoint: {host}/sintia/api/ws
Method: POST
Headers:
- Content-Type: text/xml
- authorization: {authorization}
- x-csrf-token: {x-csrf-token}
Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sin="https://portalunico.siscomex.gov.br/sintia">
    <soapenv:Header />
    <soapenv:Body>        
        <!-- ... -->        
    </soapenv:Body>
</soapenv:Envelope>
Nome Descrição Tipo do dado
authorization jwt com as informaƧƵes do usuƔrio autenticado string
x-csrf-token token de seguranƧa string
body Soap Body string

A especificação do Soap Body estÔ disponível nesse link.