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
- Homologação: https://hom.pucomex.serpro.gov.br
- Treinamento: https://val.portalunico.siscomex.gov.br
- Produção: https://portalunico.siscomex.gov.br
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.