-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
https://docs.portalunico.siscomex.gov.br/rn/r36-guaiba/
- Loading branch information
facchinello
committed
Jul 20, 2021
1 parent
9df105b
commit 9f5209c
Showing
309 changed files
with
37,130 additions
and
4,121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
src/main/java/br/gov/siscomex/portalunico/cadatributos/api/AtributoNcmApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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çã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çã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ção</td> <td class=\"tg-corpo\">https://portalunico.siscomex.gov.br/cadatributos/api/ext/atributo-ncm/download/{tipo}</td> </tr> </tbody> </table> <p> </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); | ||
} | ||
|
45 changes: 42 additions & 3 deletions
45
src/main/java/br/gov/siscomex/portalunico/catp/api/OperadorEstrangeiroApi.java
Large diffs are not rendered by default.
Oops, something went wrong.
10 changes: 5 additions & 5 deletions
10
src/main/java/br/gov/siscomex/portalunico/catp/api/ProdutoApi.java
Large diffs are not rendered by default.
Oops, something went wrong.
51 changes: 51 additions & 0 deletions
51
src/main/java/br/gov/siscomex/portalunico/catp/api/RegimeEspecialApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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álogo de Produtos</h3><h4>Introdução</h4> <p>Bem-vindo à API do sistema Catálogo de Produtos.</p> <p>O sistema <strong>Catálogo de Produtos</strong> permite a manutenção de catálogos de produtos e operadores estrangeiros, individualizados por empresa, visando ao reuso das informações nas operações de comércio exterior.<p> <p>As informaçõ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ços descritos a seguir. A estrutura do arquivo JSON é a mesma para as duas modalidades de uso.</p> <p>No arquivo com os produtos a serem importados, além dos dados básicos, devem ser preenchidos os atributos associados ao código NCM de cada produto. Os atributos preenchidos para cada produto devem respeitar os códigos do respectivo ambiente - treinamento (validação) ou produção. Devem ser considerados somente os atributos que contenham o objetivo Produto.</P> <p>Nos endereços a seguir estão disponíveis as relaçõ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ção</a></li> <li><a href=\"https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json\">Ambiente de Produção</a></li> </ul> <p>As operações que podem ser gerenciadas pela API do sistema são:</p> <ul> <li>Consultar Produtos</li> <li>Incluir/Retificar Produtos</li> <li>Exportar Catálogo de Produtos</li> <li>Detalhar Versão do Produto</li> <li>Incluir/Retificar Operador Estrangeiro</li> <li>Exportar Catálogo de Operadores Estrangeiros</li> <li>Vincular/Desvincular Fabricante-Produtor a Produto</li> <li>Exportar Vínculos de Fabricante-Produtor a Produto</li> <li>Incluir Atos Concessórios</li> </ul> <h4>URLs de Acesso</h4> <p>Para utilizar os serviços disponíveis nesta API, deve-se aplicar o seguinte padrão de URL:</p> <p><em>https://{ambiente}/<strong>catp</strong>/api/{serviço}</em></p> <p>Onde: <strong>{ambiente}</strong> indica o ambiente desejado, de acordo com a tabela abaixo; e <strong>{serviço}</strong> indica a URI do serviç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ção das Empresas</td> <td class=\"tg-corpo\">val.portalunico.siscomex.gov.br</td> </tr> <tr> <td class=\"tg-corpo\">Ambiente de Produção</td> <td class=\"tg-corpo\">portalunico.siscomex.gov.br</td> </tr> </tbody> </table> <p> </p> <p><strong>Exemplo:</strong> Para o serviço \"Incluir/Alterar Produtos\" a URI é <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); | ||
} | ||
|
Oops, something went wrong.