Skip to content

Commit

Permalink
https://docs.portalunico.siscomex.gov.br/rn/r36-guaiba/
Browse files Browse the repository at this point in the history
  • Loading branch information
facchinello committed Jul 20, 2021
1 parent 9df105b commit 9f5209c
Show file tree
Hide file tree
Showing 309 changed files with 37,130 additions and 4,121 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>samuelfac</groupId>
<artifactId>portalunico.siscomex.gov.br</artifactId>
<version>amarelo</version>
<version>guaiba</version>
<name>PortalUnicoSiscomex</name>

<description>Classes da API do Portal Único de Comércio Exterior, a nova forma de interação entre as empresas privadas e os diversos órgãos públicos intervenientes no comércio exterior.</description>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package br.gov.siscomex.portalunico.cadatributos.api;


import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

/**
* Cadastro de Atributos
*
* <p><h3>CADA - Cadastro de Atributos</h3><h4>Introdu&ccedil;&atilde;o</h4> <p>Bem-vindo à API do sistema Cadastro de Atributos.</p> <p>O <strong>Cadastro de Atributos</strong> fornece a relação dos atributos configurados pelos órgãos de governo para os códigos de mercadoria (NCM). A relação é atualizada diariamente, à meia-noite, e pode ser consultada para a data atual ou para outra data de referência.<p> <p>O serviço disponibilizado nesta API é <strong>\"Download do arquivo de Lista de Atributos por NCM\"</strong>, cuja especificação será descrita abaixo.</p> <h4>URLs de Acesso</h4> <p>Para utilizar o serviço, deve-se acessar uma das URLs que seguem, de acordo com o ambiente utilizado:</p> <style type=\"text/css\"> .tg {border-collapse:collapse;border-color:#bbb;border-spacing:0;width: 604px;} .tg td{background-color:#E0FFEB;border-color:#bbb;border-style:solid;border-width:1px;color:#594F4F; font-family:Arial, sans-serif;font-size:14px;overflow:hidden;padding:10px 5px;word-break:normal;} .tg th{background-color:#9DE0AD;border-color:#bbb;border-style:solid;border-width:1px;color:#493F3F; font-family:Arial, sans-serif;font-size:14px;font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;} .tg .tg-cabecalho{text-align:left;vertical-align:top}.tg .tg-corpo{border-color:inherit;text-align:left;vertical-align:top} </style> <table class=\"tg\" style=\"width: 604px;\"> <thead> <tr> <th class=\"tg-cabecalho\"><span style=\"font-weight:bold\">Nome do Ambiente</span></th> <th class=\"tg-cabecalho\"><span style=\"font-weight:bold\">URL de acesso</span></th> </tr> </thead> <tbody> <tr> <td class=\"tg-corpo\">Ambiente de Valida&#231;&#227;o das Empresas</td> <td class=\"tg-corpo\">https://val.portalunico.siscomex.gov.br/cadatributos/api/ext/atributo-ncm/download/{tipo}</td> </tr> <tr> <td class=\"tg-corpo\">Ambiente de Produ&#231;&#227;o</td> <td class=\"tg-corpo\">https://portalunico.siscomex.gov.br/cadatributos/api/ext/atributo-ncm/download/{tipo}</td> </tr> </tbody> </table> <p>&nbsp;</p>
*
*/
@Path("/")
@Api(value = "/", description = "")
public interface AtributoNcmApi {

/**
* Download do arquivo de Lista de Atributos por NCM
*
*/
@GET
@Path("/ext/atributo-ncm/download/{tipo}")
@ApiOperation(value = "Download do arquivo de Lista de Atributos por NCM", notes = "", tags={ "Atributo NCM" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Operação realizada com sucesso"),
@ApiResponse(code = 400, message = "Requisição inválida"),
@ApiResponse(code = 401, message = "Usuário não autenticado ou autenticação inválida"),
@ApiResponse(code = 403, message = "Usuário não tem permissão de acesso ao recurso"),
@ApiResponse(code = 404, message = "Recurso não encontrado"),
@ApiResponse(code = 422, message = "Erro(s) de validação da camada de negócio"),
@ApiResponse(code = 500, message = "Erro interno no servidor") })
public Response download(@ApiParam(value = "Tipo do arquivo a ser gerado.<br>xml<br>json",required=true, allowableValues="xml, json") @PathParam("tipo") String tipo, @ApiParam(value = "JSON Web Token (JWT) contendo as informações do usuário. Este token é recuperado no parâmetro Set-Token no response da autenticação" ,required=true)@HeaderParam("Authorization") String authorization, @ApiParam(value = "Token de prevenção contra ataques CSRF. Este token é recuperado no parâmetro X-CSRF-Token no response da autenticação" ,required=true)@HeaderParam("X-CSRF-Token") String xCSRFToken, @ApiParam(value = "Data de referência do arquivo, no formato ISO, com precisão de dias.<br>Formato: yyyy-MM-dd") @QueryParam("data") String data);
}

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package br.gov.siscomex.portalunico.catp.api;

import java.util.List;

import javax.validation.Valid;
import javax.ws.rs.Consumes;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;

import br.gov.siscomex.portalunico.catp.model.LoteValidacaoDTO;
import br.gov.siscomex.portalunico.catp.model.RegimeEspecialIntegracaoDTO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

/**
* Catálogo de Produtos
*
* <p><h3>CATP - Cat&#225;logo de Produtos</h3><h4>Introdu&ccedil;&atilde;o</h4> <p>Bem-vindo à API do sistema Cat&#225;logo de Produtos.</p> <p>O sistema <strong>Cat&#225;logo de Produtos</strong> permite a manuten&#231;&#227;o de cat&#225;logos de produtos e operadores estrangeiros, individualizados por empresa, visando ao reuso das informa&#231;&#245;es nas opera&#231;&#245;es de com&#233;rcio exterior.<p> <p>As informa&#231;&#245;es sobre os produtos e operadores estrangeiros podem ser importadas de arquivos JSON, tanto pela interface Web, via upload de arquivo, quando pelo acionamento dos servi&#231;os descritos a seguir. A estrutura do arquivo JSON &#233; a mesma para as duas modalidades de uso.</p> <p>No arquivo com os produtos a serem importados, al&#233;m dos dados b&#225;sicos, devem ser preenchidos os atributos associados ao c&#243;digo NCM de cada produto. Os atributos preenchidos para cada produto devem respeitar os c&#243;digos do respectivo ambiente - treinamento (valida&#231;&#227;o) ou produ&#231;&#227;o. Devem ser considerados somente os atributos que contenham o objetivo Produto.</P> <p>Nos endere&#231;os a seguir est&#227;o dispon&#237;veis as rela&#231;&#245;es de atributos por NCM para cada ambiente:</p> <ul> <li><a href=\"https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json\">Ambiente de Treinamento/Valida&#231;&#227;o</a></li> <li><a href=\"https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json\">Ambiente de Produ&#231;&#227;o</a></li> </ul> <p>As opera&ccedil;&otilde;es que podem ser gerenciadas pela API do sistema s&atilde;o:</p> <ul> <li>Consultar Produtos</li> <li>Incluir/Retificar Produtos</li> <li>Exportar Cat&#225;logo de Produtos</li> <li>Detalhar Vers&#227;o do Produto</li> <li>Incluir/Retificar Operador Estrangeiro</li> <li>Exportar Cat&#225;logo de Operadores Estrangeiros</li> <li>Vincular/Desvincular Fabricante-Produtor a Produto</li> <li>Exportar V&#237;nculos de Fabricante-Produtor a Produto</li> <li>Incluir Atos Concess&#243;rios</li> </ul> <h4>URLs de Acesso</h4> <p>Para utilizar os servi&ccedil;os dispon&iacute;veis nesta API, deve-se aplicar o seguinte padr&atilde;o de URL:</p> <p><em>https://{ambiente}/<strong>catp</strong>/api/{servi&ccedil;o}</em></p> <p>Onde: <strong>{ambiente}</strong> indica o ambiente desejado, de acordo com a tabela abaixo; e <strong>{servi&#231;o}</strong> indica a URI do servi&#231;o desejado.</p> <style type=\"text/css\"> .tg {border-collapse:collapse;border-color:#bbb;border-spacing:0;width: 604px;} .tg td{background-color:#E0FFEB;border-color:#bbb;border-style:solid;border-width:1px;color:#594F4F; font-family:Arial, sans-serif;font-size:14px;overflow:hidden;padding:10px 5px;word-break:normal;} .tg th{background-color:#9DE0AD;border-color:#bbb;border-style:solid;border-width:1px;color:#493F3F; font-family:Arial, sans-serif;font-size:14px;font-weight:normal;overflow:hidden;padding:10px 5px;word-reak:normal;} .tg .tg-cabecalho{text-align:left;vertical-align:top}.tg .tg-corpo{border-color:inherit;text-align:left;vertical-align:top} </style> <table class=\"tg\" style=\"width: 604px;\"> <thead> <tr> <th class=\"tg-cabecalho\"><span style=\"font-weight:bold\">Nome do Ambiente</span></th> <th class=\"tg-cabecalho\"><span style=\"font-weight:bold\">URL de acesso</span></th> </tr> </thead> <tbody> <tr> <td class=\"tg-corpo\">Ambiente de Valida&#231;&#227;o das Empresas</td> <td class=\"tg-corpo\">val.portalunico.siscomex.gov.br</td> </tr> <tr> <td class=\"tg-corpo\">Ambiente de Produ&#231;&#227;o</td> <td class=\"tg-corpo\">portalunico.siscomex.gov.br</td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>Exemplo:</strong> Para o servi&ccedil;o \"Incluir/Alterar Produtos\" a URI &eacute; <p><em>https://val.portalunico.siscomex.gov.br/catp/api/ext/produto</em></p>
*
*/
@Path("/")
@Api(value = "/", description = "")
public interface RegimeEspecialApi {

/**
* Incluir Atos Concessórios
*
*/
@POST
@Path("/ext/regime-especial")
@Consumes({ "application/json" })
@Produces({ "application/json" })
@ApiOperation(value = "Incluir Atos Concessórios", notes = "", tags={ "Regime Especial" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Operação realizada com sucesso", response = LoteValidacaoDTO.class, responseContainer = "List"),
@ApiResponse(code = 204, message = "Operação realizada com sucesso. Nenhum conteúdo retornado"),
@ApiResponse(code = 400, message = "Requisição mal formatada"),
@ApiResponse(code = 401, message = "Usuário não autenticado ou autenticação inválida"),
@ApiResponse(code = 403, message = "Usuário não tem permissão de acesso ao recurso"),
@ApiResponse(code = 404, message = "Recurso não encontrado"),
@ApiResponse(code = 422, message = "Erro(s) de validação da camada de negócio"),
@ApiResponse(code = 500, message = "Erro interno no servidor") })
public Response incluir(@ApiParam(value = "Lista de Atos Concessórios" ,required=true)@Valid List<RegimeEspecialIntegracaoDTO> body, @ApiParam(value = "JSON Web Token (JWT) contendo as informações do usuário. Este token é recuperado no parâmetro Set-Token no response da autenticação" ,required=true)@HeaderParam("Authorization") String authorization, @ApiParam(value = "Token de prevenção contra ataques CSRF. Este token é recuperado no parâmetro X-CSRF-Token no response da autenticação" ,required=true)@HeaderParam("X-CSRF-Token") String xCSRFToken);
}

Loading

0 comments on commit 9f5209c

Please sign in to comment.