Noov REST API é a interface de comunicação com a qual as aplicações Noov podem fazer consultas aos dados de Documentos Fiscais Eletrônicos armazenados no Noov. Neste manual estão documentados todos os recursos e serviços disponibilizados através da API. Os recursos estão categorizados em tópicos. Cada tópico compreende um módulo para integração.
1. Glossário
Abaixo está um glossário de termos que serão utilizados nessa documentação.
Nome | Descrição |
---|---|
DF-e |
Documento Fiscal Eletrônico. Refere-se a qualquer documento padronizado pelo fisco (NF-e, NFC-e, CT-e, MDF-e e MD-e). |
End-Point |
Ponto de conexão para um sistema que permite integrações. Nesta documentação será utilizado para representar os URIs dos recursos disponibilizados pela API. |
Payload |
No contexto da API REST trata-se do corpo de uma requisição. |
timestamp |
Marca temporal. Número inteiro com precisão de milisegundos contados a partir de 01/01/1970 00:00:00.000 UTC |
URI |
Universal Resource Identifier. Trata-se de um identificador único de recursos
disponibilizados na Internet. Por exemplo |
2. Integração Facilitada com SDKs
Para facilitar a integração com a API, são disponibilizados Kits de Desenvolvimento de Software (SDK). Atualmente existe apenas o SDK para Java. Em breve serão disponibilizados SDKs em outras linguagens.
2.1. SDK Java
O SDK em Java pode ser encontrado em nosso repositório maven. Para utilizá-lo em um projeto maven basta adicionar a seguinte dependência:
<dependency>
<groupId>br.com.oobj.public</groupId>
<artifactId>oobj-dfe-noov-sdk</artifactId>
<version>RELEASE</version>
</dependency>
Adicionalmente é necessário configurar o nosso servidor de artefatos binários maven. Para tal, adicione o nosso repositório às configurações:
<repositories>
<repository>
<id>noov-repo</id>
<name>Repositorio Noov</name>
<url>http://maven.oobj.com.br/nexus/content/repositories/oobj-public/</url>
</repository>
</repositories>
Caso prefira, também é possível fazer o download do JAR com todas as dependências.
2.1.1. Exemplos de Utilização
Para utilizar o SDK Java é necessário instanciar um objeto da classe NoovClient
:
NoovClient noovClient = AppNoovClient.getInstance(NOOV_API_KEY, NOOV_API_SECRET, NOOV_APP_NAME, NOOV_APP_EMAIL_DESENV);
Como é possível observar, são necessários o API Key e API Secret, o nome do aplicativo e o e-mail do desenvolvedor (usuário que o cadastrou).
Com a instancia de NoovClient
é possível requisitar qualquer end-point da API utilizando
os métodos makeAuthenticatedGetRequest
, makeAuthenticatedPostRequest
, makeAuthenticatedPutRequest
,
makeAuthenticatedDeleteRequest
:
NoovHttpResponse response = noovClient
.makeAuthenticatedPostRequest(uri, payload,
ContentType.APPLICATION_XML.getMimeType());
Os métodos makeAuthenticatedPostRequest
e makeAuthenticatedPutRequest
são para realização de
requisições POST e PUT, respectivamente. Eles recebem 2 parâmetros do tipo String e 1 do tipo byte[]:
-
URI (String): O endereço completo do recurso a ser requisitado.
-
Payload (byte[]): O conteúdo do corpo da requisição (costumeiramente um xml ou json).
-
Content Type (String): O tipo do conteúdo. Por exemplo
application/xml
.
Os métodos makeAuthenticatedGetRequest
e makeAuthenticatedDeleteRequest
são para realização de
requisições GET e DELETE, respectivamente. A diferença destes para os anteriores está no segundo parâmetro.
Ao invés de ser uma String com o payload, é um Map com os parâmetros da requisição. Para cada elemento do Map
a chave é o nome do parâmetro. Abaixo está um exemplo de código:
NoovClient noovClient = AppNoovClient.getInstance(API_KEY, API_SECRET, APP_NAME, DEV_EMAIL);
Map<String, String> params = new HashMap<>();
params.put("docKey", "12345678901234");
NoovHttpResponse response = noovClient
.makeAuthenticatedGetRequest("/app/enrichment", params, "text/plain");
O retorno dos métodos é um objeto da classe NoovHttpResponse
. Os métodos relevantes dessa classe são:
-
String getContent()
: retorna o corpo da resposta da requisição. -
Integer getStatus()
: retorna o Http Status da requisição. -
Map<String, String> getHeaders()
: retorna um Map contendo os cabeçalhos da resposta.
Adicionalmente existe uma classe específica para o serviço de envio de documentos
fiscais eletrônicos, a UploadService
. Abaixo um exemplo de utilização dessa classe:
UploadService uploadService = new UploadService(noovClient);
STATUS_NOOV statusNoov = uploadXmlService.upload(xmlProc, nomeArquivo);
No exemplo acima a variável xmlProc
é um byte[], com o conteúdo de um XML do DF-e, enquanto a variável nomeArquivo
é o nome deste arquivo XML. Perceba que ambos parâmetros são obrigatórios.
3. Introdução
A API REST do Noov possui uma série de padrões para todos os serviços e recursos a serem consumidos. Tais padrões serão descritos em mais detalhes nesta seção.
3.1. API Key e API Secret
Para utilizar a API do Noov é necessário ter uma aplicação cadastrada e aprovada. Assim que o cadastro da aplicação é aprovado, são geradas as credenciais de acesso. Trata-se do API Key e API Secret. O API Key é uma chave de acesso utilizada para autenticação do aplicativo. Ela é aleatoria e única para cada aplicativo. O API Secret é um código secreto também gerado aleatoriamente. Esse código é usado no momento da autenticação da aplicação para geração de um hash que valida os dados, estabelecendo uma assinatura para a requisição de autenticação.
c94a88a5-17c0-4ccc-a31b-f4c6d390f09a
421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173c1d87
3.2. Possíveis HTTP Status
A tabela a seguir detalha os possíveis HTTP Status
que podem ocorrer no
retorno de uma requisição à API. Essa tabela poderá ser utilizada como
referência para todos os recursos e serviços da API.
Código | Nome | Motivo |
---|---|---|
200 |
OK |
Requisição realizada com sucesso. |
202 |
Accepted |
A requisição foi aceita para processamento. |
400 |
Bad Request |
Os dados enviados na requisição estão incorretos. |
401 |
Unauthorized |
O recurso precisa de autenticação para ser consumido e a requisição não está autenticada ou a autenticação está incorreta. |
403 |
Forbidden |
O aplicativo ou usuário que está realizando a requisição não possui permissão. |
404 |
Not Found |
Não foi encontrado qualquer resultado para esta requisição. |
3.3. Requisição de Recursos
Antes de consumir qualquer recurso da API é necessário autenticar-se.
Estando a aplicação devidamente autenticada, faz-se SEMPRE necessário passar
o token
gerado, no cabeçalho da requisição para se ter acesso aos recursos.
Content-Type : application/json Authorization : Bearer qrwr09FA3Ffq9.fiAdH67EhVAsdyQF233
3.4. Estrutura padrão de Resposta
Todos os recursos da API são retornados em formato JSON, seguindo uma estrutura padrão formada por três campos, como pode ser visto na tabela abaixo:
Nome do campo | Descrição |
---|---|
|
(Opcional) Quando retornado, contém meta-dados acerca da resposta ou do recurso retornado. Erros e mensagens de sucesso são retornadas nesse campo. |
|
(Opcional) Contem a representação do recurso requisitado. Quando não há recurso para ser retornado, esse campo não é informado na resposta. Alguns end-points podem retornar listagens (array) neste campo, sendo comum o uso de paginação nesses casos. |
|
(Opcional) Quando retornado, informa dados sobre a paginação dos recursos
disponibilizados em |
Como é possível observar, todos os campos são opcionais. Entretanto, os campos
meta
e data
são passíveis de aparecer em qualquer requisição. Toda resposta
de erro terá apenas o campo meta
. As respostas de sucesso, que retornam
recursos, necessariamente terão o campo data
. Já o campo pagination
, apenas
em listagens paginadas.
3.4.1. Paginação
A API do Noov possui duas formas de paginação: Paginação Estática e Paginação Dinâmica. Os dois tipos de paginação possuem alguns campos em comum (listados na tabela a seguir) e alguns detalhes específicos.
Nome do campo | Tipo | Descrição |
---|---|---|
|
Integer |
Tamanho da página. Ou seja, a quantidade de elementos máximo que uma página
pode conter. A maioria dos end-points que retornam listagens podem ser
configurados na requisição para utilizarem um tamanho de página específico. Porém,
no caso da paginação dinâmica, a API impõe atualmente um |
|
Integer |
A quantidade total de elementos da página em questão. Apenas a última página
possuirá |
|
Boolean |
Se verdadeiro (true) indica que a página em questão é a última. |
Paginação Estática
Esse tipo de paginação é usado quando o recurso é uma listagem cujo tamanho total é conhecido. Assim, a paginação segue o formato convencional, no qual é informado o total de elementos, e o número da página em questão. A tabela abaixo apresenta os campos específicos da paginação estática:
Nome do campo | Tipo | Descrição |
---|---|---|
|
Integer |
O número da página atual, sendo que o número da primeira página é 0. |
|
Long |
A quantidade total de elementos da listagem retornada (correspondente a totalização de todas as páginas). |
Paginação Dinâmica
A Paginação Dinâmica é utilizada quando a quantidade total de resultados é difícil de ser obtida. A utilização desse tipo de paginação é comum em recursos que envolvem agregações e operações de consulta mais complexas. A tabela abaixo apresenta os campos específicos da paginação dinâmica:
Nome do campo | Tipo | Descrição |
---|---|---|
|
Long |
O próximo protocolo a ser informado. Na paginação dinâmica, para requisitar a
próxima página, basta informar o |
3.4.2. Mensagens de Erros
A API Noov possui padronização com relação às mensagens de erro. Com isso, os
erros, independente do recurso ou end-point serão retornados sempre da mesma
forma. Quando há erros, o campo meta possuirá um atributo
errors
contendo uma listagem de erros expressos de acordo com a tabela abaixo:
Nome do campo | Tipo | Descrição |
---|---|---|
|
String |
Nome ou título sobre o erro. Em caso de uma exceção esperada em algum fluxo alternativo, é informado o nome da exceção. |
|
String |
Uma mensagem com detalhes sobre o erro ocorrido. |
É importante observar que mesmo que seja retornado apenas um erro, ele será
representado dentro de uma lista (array) no atributo errors
do campo meta
.
Adicionalmente, quando um erro ocorre, o Status HTTP de resposta
é correspondente ao erro.
4. Autenticação de Aplicativos
Para utilizar os recursos disponíveis para aplicativos, é necessário autenticação previa, através de end-point especifico.
4.1. Campos de Requisição e Resposta
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/request-fields.adoc[]
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/response-fields.adoc[]
4.2. Recursos
4.2.1. Login de Aplicativo
POST /auth/login
Ao fazer uma requisição para esse recurso, certifique-se de que o campo
timestamp
contém o timestamp atual e que o campo secret
é formado através
dos seguintes passos:
-
Concatenação no nome da aplicação + e-mail do desenvolvedor + timestamp. Por exemplo:
NoovDashboarddemo@noov.com.br1462221821899
-
Geração de hash a partir de algoritmo
HMAC_SHA256
, utilizando aAPI Secret
da aplicação em questão. O resultado será uma sequência de caracteres na base hexadecimal. Abaixo está um exemplo de resultado final da geração do hashHMAC_SHA256
:
221405e09663d12774f6373cb7c2232ac5ae6db930ef454e20a572014040f0a4
Na requisição de autenticação, o atributo secret não é o API Secret da
aplicação e sim o hash gerado de acordo com os passos acima.
|
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/http-request.adoc[]
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/curl-request.adoc[]
200 OK
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/http-response.adoc[]
400 Bad Request
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login-old-timestamp/http-response.adoc[]
401 Unauthorized
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login-incorrect-secret/http-response.adoc[]
4.2.2. Atualização de token
POST /app/refresh-token
O token gerando na autenticação expira em 30 minutos. O aplicativo que deseja ficar continuamente consumindo recursos deve, de tempos em tempos, requisitar um novo token.
O novo token deve ser requisitado antes do token atual expirar. Caso contrário, será necessário realizar o procedimento de login novamente. |
Para adquirir um novo token, basta realizar uma requisição à esse recurso, passando o token antigo (conforme o consumo normal de um recurso autenticado). Em caso de sucesso, um novo token será gerado e retornado da mesma forma que o serviço de login realiza.
Há uma limitação de tempo para que um token possa ser renovado. Assim, não é possível renovar um token que acabou de ser criado, por exemplo.
O token deve ser revalidado nos 10 últimos minutos antes de sua expiração. |
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/refresh/http-request.adoc[]
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/refresh/curl-request.adoc[]
200 OK
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/login/http-response.adoc[]
403 Forbidden
Unresolved directive in app-auth.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/auth/refresh/http-response.adoc[]
5. Recursos Genéricos (DF-es)
Nesta seção serão descritos serviços e recursos utilizados para qualquer DF-e.
5.1. Recursos
5.1.1. Enviar Documento
POST /dfe
Este é o recurso pelo qual qualquer XML de Documento Fiscal Eletrônico pode ser enviado, até mesmo eventos. Para consumo deste serviço, basta enviar o XML no payload da requisição autenticada.
5.1.2. Campos para Requisição
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload/request-parameters.adoc[]
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload/http-request.adoc[]
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload/curl-request.adoc[]
202 Accepted
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload/http-response.adoc[]
5.1.3. Enviar Documento com nome do arquivo
POST /dfe/{nome-do-arquivo}
Este é o recurso pelo qual qualquer XML de Documento Fiscal Eletrônico pode ser enviado, até mesmo eventos. Para consumo deste serviço, basta enviar o XML no payload da requisição autenticada.
5.1.4. Campos para Requisição
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload-filename/request-parameters.adoc[]
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload-filename/http-request.adoc[]
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload-filename/curl-request.adoc[]
202 Accepted
Unresolved directive in dfes.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/upload-filename/http-response.adoc[]
6. Nota Fiscal Eletrônica (NF-e)
Os recursos aqui descritos fazem uso dos mesmos campos para requisição.
6.1. Campos para Requisição
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/nfe-lista-example/request-fields.adoc[]
6.2. Recursos
Estes recursos retornam dados apenas para os CNPJs permitidos para a aplicação que está o consumindo, ou seja:
-
Caso seja passado algum CNPJ não permitido como parâmetro, a aplicação fará o relacionamento deste aos permitidos.
-
Caso não seja passado qualquer CNPJ, a consulta será feita com base apenas nos CNPJs permitidos.
6.2.1. Requisitar Documento de NFe
POST /nfe
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Documentos de NFe.
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/nfe-lista-example/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/nfe-lista-example/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/find-cancelados/http-response.adoc[]
404 Not Found
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/nfe-lista-example/http-response.adoc[]
6.2.2. Requisitar Documentos de Produtos da NFe
POST /nfe/produto
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de documentos de produtos extraídos das NFe, exatamente como aparecem nas mesmas.
-
Caso o campo
allCnpj
seja utilizado, serão consultados dados de todos os CNPJs cadastrados.
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-nao-encontrado/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-nao-encontrado/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-lista/http-response.adoc[]
404 Not Found
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-nao-encontrado/http-response.adoc[]
6.2.3. Requisitar Produtos de NFe Sumarizados
POST /nfe/produto/sumarizacao
-
Este recurso retorna uma lista de produtos com os seguintes dados sumarizados:
-
Valor Médio.
-
Valor Total.
-
Valor Unitário.
-
Quantidade de produtos vendidos.
-
-
Caso o campo
allCnpj
seja utilizado, serão consultados dados de todos os CNPJs cadastrados. -
O campo
CEAN
é obrigatório.
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-sumarizacao/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-sumarizacao/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-sumarizacao/http-response.adoc[]
400 Bad Request
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-sumarizacao-ean-missing/http-response.adoc[]
404 Not Found
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-nao-encontrado/http-response.adoc[]
6.2.4. Requisitar Evento relacionado a NFe
POST /nfe/evento
Esse recurso utiliza paginação estática. |
-
Este recurso pode ser utlizado de duas formas:
-
Passando os campos
modelo
,numero
,serie
eemiCnpj
da NFe corretamente preenchidos na requisição. -
Passando o campo
chave
da NFe corretamente preenchido na requisição.
-
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/evento-nfe-not-found/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/evento-nfe-not-found/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/evento-chave-found/http-response.adoc[]
400 Bad Request
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/evento-nfe-not-found/http-response.adoc[]
400 Bad Request
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/evento-insufficient-data/http-response.adoc[]
404 Not Found
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/produto-nao-encontrado/http-response.adoc[]
6.2.5. Requisitar Arquivo XML da NFe
GET /nfe/{accessKey}
Esse recurso não oferece paginação. |
-
Este recurso retorna o arquivo XML da NFe para download.
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/xml-chave-acesso/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/xml-chave-acesso/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/xml-chave-acesso/http-response.adoc[]
404 Not Found
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/xml-nao-encontrado/http-response.adoc[]
6.2.6. Requisitar quantidade de NFes emitidas por período
GET /nfe/stats/emissao
Esse recurso não oferece paginação. |
-
Este recurso retorna a quantidade de NFes emitidas para o período.
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/stats-emissao/http-request.adoc[]
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/stats-emissao/curl-request.adoc[]
200 OK
Unresolved directive in nfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/stats-emissao/http-response.adoc[]
7. Nota Fiscal Do Consumidor Eletrônica (NFC-e)
Os recursos aqui descritos fazem uso dos mesmos campos para requisição.
7.1. Campos para Requisição
Unresolved directive in nfce-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfce/nfce-lista-example/request-fields.adoc[]
Caso campos não pertencentes aos filtros aqui citados sejam informados, a API ignorará o campo passado.
7.2. Recursos
Estes recursos retornam dados apenas para os CNPJs permitidos para a aplicação que está o consumindo, ou seja:
-
Caso seja passado algum CNPJ não permitido como parâmetro, a aplicação fará o relacionamento deste aos permitidos.
-
Caso não seja passado qualquer CNPJ, a consulta será feita com base apenas nos CNPJs permitidos.
7.2.1. Requisitar Documento de NFCe
POST /nfce
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Documentos de NFCe.
Unresolved directive in nfce-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfce/nfce-lista-example/http-request.adoc[]
Unresolved directive in nfce-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfce/nfce-lista-example/curl-request.adoc[]
404 Not Found
Unresolved directive in nfce-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfce/nfce-lista-example/http-response.adoc[]
8. Cupom Fiscal Eletrônico (CF-e)
Os recursos aqui descritos fazem uso dos mesmos campos para requisição.
8.1. Campos para Requisição
Unresolved directive in cfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cfe/cfe-lista-example/request-fields.adoc[]
Caso campos não pertencentes aos filtros aqui citados sejam informados, a API ignorará o campo passado.
8.2. Recursos
Estes recursos retornam dados apenas para os CNPJs permitidos para a aplicação que está o consumindo, ou seja:
-
Caso seja passado algum CNPJ não permitido como parâmetro, a aplicação fará o relacionamento deste aos permitidos.
-
Caso não seja passado qualquer CNPJ, a consulta será feita com base apenas nos CNPJs permitidos.
8.2.1. Requisitar Documento de CFe
POST /cfe
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Documentos de CFe.
Unresolved directive in cfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cfe/cfe-lista-example/http-request.adoc[]
Unresolved directive in cfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cfe/cfe-lista-example/curl-request.adoc[]
404 Not Found
Unresolved directive in cfe-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cfe/cfe-lista-example/http-response.adoc[]
9. Totalizações de Nota Fiscal Eletrônica (NF-e)
O recurso aqui descrito faz uso dos seguintes campos para requisição.
9.1. Campos para Requisição
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/documentacao-campos/request-parameters.adoc[]
9.2. Recursos
As seguintes regras se aplicam a este recurso:
-
O NOOV não retornará dados de empresas que o aplicativo não tenha acesso às NFes e/ou permissão para acessar específicamente o Valor Total de suas NFes.
-
Caso seja passada a chave da NFe, a consulta será feita com base apenas na chave.
-
Caso a chave da NFe não seja passada, os campos
dia
eemits
se tornam OBRIGATÓRIOS.
9.2.1. Requisitar Totalização
GET /nfe/totalizer
Esse recurso não utiliza paginação. |
-
Este recurso retorna uma lista contendo o Valor Total da NFe por vendedor, CFOPs e dia.
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/documentacao-campos/http-request.adoc[]
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/documentacao-campos/curl-request.adoc[]
200 OK
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/consulta-pela-chave/http-response.adoc[]
404 Not Found
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/not-found/http-response.adoc[]
400 Bad Request
Unresolved directive in totalizer-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/nfe/totalizer/parametros-invalidos/http-response.adoc[]
10. Conhecimento de Transporte Eletrônico (CT-e)
O seguinte recurso será utilizado para requisições relacionadas a CTEs.
10.1. Campos para Requisição
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-lista-example/request-fields.adoc[]
10.1.1. Requisitar valor total do frete.
POST /cte/totalFrete
Esse recurso não utiliza paginação. |
-
Este recurso retorna uma lista de valores totais de frete.
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-lista-example/http-request.adoc[]
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-lista-example/curl-request.adoc[]
200 OK
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-lista-example/http-response.adoc[]
404 Not Found
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-nao-encontrado/http-response.adoc[]
CNPJ
inválido 400 Bad Request
Unresolved directive in cte-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/cte/cte-cnpj-invalido/http-response.adoc[]
11. Dados de Envolvidos
O seguinte recurso será utilizado para requisitar os envolvidos (clientes, fornecedores, destinatarios, trasnsportadores, tomadores, expeditores, remetentes) em relação à algum CNPJ cadastrado que a aplicação tenha acesso.
11.1. Campos para Requisição
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/cliente-ultima-data/request-fields.adoc[]
11.2. Tipos de Envolvimento
Código | Nome |
---|---|
1 |
Fornecedores |
2 |
Clientes |
3 |
Transportadores |
4 |
Remetentes |
5 |
Expeditores |
6 |
Tomadores |
7 |
Destinatarios |
11.3. Recurso
Estes recursos retornam dados como endereco, CNPJ ou CPF, nome e telefone dos envolvidos de acordo com o CNPJ passado como parametro e o tipo de envolvimento pretendido.
-
Os campos
cnpj
etipoEnvolvimento
são obrigatórios. -
OBS: Para a consutla serão informados o
cnpj
e otipoEnvolvimento
e serão retornados todos os envolvidos no qual ocnpj
informado teve estetipoEnvolvimento
passado como parametro de consulta.
11.3.1. Requisitar dados de envolvidos
POST /envolvido
Esse recurso utiliza paginação estática. |
-
Este recurso retorna uma lista de envolvidos.
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/cliente-ultima-data/http-request.adoc[]
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/cliente-ultima-data/curl-request.adoc[]
200 OK
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/cliente-ultima-data/http-response.adoc[]
404 Not Found
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/not-found/http-response.adoc[]
CNPJ
400 Bad Request
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/cnpj-missing/http-response.adoc[]
tipoEnvolvimento
400 Bad Request
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/tipo-envolvimento-missing/http-response.adoc[]
tipoEnvolvimento
não catalogado 400 Bad Request
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/tipo-envolvimento-inexistente/http-response.adoc[]
400 Bad Request
Unresolved directive in envolvido-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/envolvido/pagina-incorreta/http-response.adoc[]
12. Empresas Permitidas
O serviço a seguir retorna dados básicos das empresas que deram permissão ao aplicativo.
12.1. Campos para Resposta
Unresolved directive in company-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/company/list-permitted/response-fields.adoc[]
12.1.1. Requisitar dados de empresas que permitem o acesso ao aplicativo e o nível de permissão.
GET /company/permitted
Esse recurso não utiliza paginação. |
-
Este recurso retorna uma lista empresas e o nível de permissão concedido.
Unresolved directive in company-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/company/list-permitted/http-request.adoc[]
Unresolved directive in company-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/company/list-permitted/curl-request.adoc[]
200 OK
Unresolved directive in company-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/company/list-permitted/http-response.adoc[]
404 Not Found
Unresolved directive in company-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/company/app-sem-permissoes/http-response.adoc[]
13. Enriquecimento de Dados
Este serviço ainda está em construção. Os end-points descritos aqui ainda não estão funcionando em produção. |
Existem cenários em que um aplicativo deseja registrar dados extras acerca de um envolvido em transações fiscais ou até mesmo acerca das transações fiscais. Nesses casos, ele pode adicionar informações extras para posterior consulta ou agregação. A essa funcionalidade deu-se o nome de "Enriquecimento de Dados".
Através da utilização de um aplicativo, uma empresa pode enviar dados, colocando alguns meta-dados para posterior consulta dela e de outras empresas. Para funcionamento adequado dos recursos abaixo, cada empresa deverá ter uma aplicativo relacionado apenas a ela.
13.1. Recursos
13.1.1. Enviar dados
POST /enrichment
Recurso destinado ao envio de dados relacionados com o CNPJ, transação fiscal ou envolvidos.
Nome | Tipo | Descrição |
---|---|---|
owner |
String |
CNPJ da empresa dona da informação. (Obrigatório) |
docKey |
String |
Chave ou CNPJ do distribuidor. (Obrigaório) |
docType |
String |
Tipo do 'docKey' do distribuidor. Ex: "cnpj", "chave". (Obrigatório) |
category |
String |
Nome da categoria dos dados a serem inseridos. Ex: "metas", "vendas". (Obrigatório) |
expirationDate |
Timestamp |
Timestamp da data de expiração dos dados enviados. (Opcional) |
startDate |
Timestamp |
Timestamp da data de inicio da validade dos dados enviados. (Opcional) |
interested |
Array de Strings |
Array contendo os CNPJs de interessados que poderão consultar os dados enviados. (Opcional) |
data |
Array de Object |
Array de Objetos com os dados a serem enviados. (Obrigatório) |
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/enrichment-criado/http-request.adoc[]
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/enrichment-criado/curl-request.adoc[]
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/enrichment-criado/http-response.adoc[]
13.1.2. Consultar dados
GET /enrichment
Recurso para consulta de dados enviados por alguma empresa. Esta consulta só retornará dados em que o CNPJ requisitor esteja relacionado como interessado.
Nome | Tipo | Descrição |
---|---|---|
owner |
String |
CNPJ da empresa dona da informação. (Opcional) |
docKey |
String |
Chave ou CNPJ do distribuidor. (Obrigatório) |
docType |
String |
Tipo do 'docKey' do distribuidor. Ex: "cnpj", "chave". (Opcional) |
createdAtStart |
Timestamp |
Timestamp da data de criação dos dados a serem consultados. (Opcional) |
createdAtEnd |
Timestamp |
Timestamp da data de criação dos dados a serem consultados. (Opcional) |
startAt |
Timestamp |
Timestamp da data de inicio dos dados a serem consultados. Só será utilizado caso o parâmetro searchAll seja marcado como 'true'. (Opcional) |
expireAt |
Timestamp |
Timestamp da data de expiração dos dados a serem consultados. Só será utilizado caso o parâmetro searchAll seja marcado como 'true'. (Opcional) |
category |
String |
Nome da categoria dos dados a serem consultados. Ex: "goals", "sales". (Opcional) |
searchAll |
Boolean |
Boolean que verifica se a consulta retornará todos os itens do filtro(TRUE) OU apenas os itens dentro de um período de datas(FALSE). (Opcional) |
lastCreated |
Boolean |
Boolean que verifica se a consulta retornará apenas o último documento criado para o filtro(TRUE) OU todos os documentos para o filtro(FALSE). (Opcional) |
query |
JSON |
JSON contento um filtro dentro dos dados (Opcional). |
O campo query
, caso informado, deverá ser um JSON contendo nome e valor dos campos para realização de filtro. Por exemplo,
caso seja necessário filtrar apenas metas do supermercado de código 123456
(storeCode
), bastaria passar a seguinte
string no campo query
:
{"storeCode": "123456"}
Neste campo é possível informar mais de um filtro. Por exemplo:
{"storeCode": "123456", "activatedEC": true}
O campo searchAll
é FALSE por default. Desta forma caso não seja marcado como TRUE
sempre retornará as metas referentes ao período em que a data da requisição encontra-se
entre o startDate e o expirationDate.
O campo lastCreated
é FALSE por default. Desta forma sempre retornará TODAS as metas
referentes aos outros parâmetros da consulta. Caso marcado como TRUE, retornará apenas
o último documento de metas inserido, baseando-se na data de criação.
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/listar-todos/http-request.adoc[]
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/listar-todos/curl-request.adoc[]
Unresolved directive in enriquecimento.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/enrichment/listar-todos/http-response.adoc[]
14. Produtos Vendidos
14.1. Recursos
Estes recursos retornam dados apenas para os CNPJs permitidos para a aplicação que está
o consumindo, sempre comparando estes aos CNPJs enviados no parametro emits
.
14.1.1. Requisitar Produtos Vendidos
GET /sales
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Vendidos e faz uso dos seguintes campos para requisição.
14.1.2. Campos para Requisição
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-lista-example/request-parameters.adoc[]
-
O campo
status
pode conter os seguintes valores:
Status | Descrição |
---|---|
|
Documento ainda não foi verificado na SEFAZ |
|
Ocorreu uma falha ao consultar o documento na SEFAZ |
|
Documento pode ter sido emitido em contingência |
|
Documento está autorizado na SEFAZ |
|
Documento está cancelado na SEFAZ |
|
Documento encontra-se denegado na SEFAZ |
|
Documento encontra-se em processamento na SEFAZ |
|
Documento rejeitado pela SEFAZ |
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-not-found/http-response.adoc[]
403 Forbidden
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-sem-permissao/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-nenhum-grupo/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-mais-de-um-grupo/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-emitentes-nulo/http-response.adoc[]
14.1.3. Requisitar Produtos Modificados
GET /sales/modified
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Vendidos que sofreram alteração no status.
-
A data de modificação inicial e final não pode ser um período maior que 31 dias.
Path | Description |
---|---|
|
OBRIGATÓRIO. Timestamp da data de última modificação inicial. Essa é a data em que o registro sofreu a última modificação. |
|
OBRIGATÓRIO. Timestamp da data de modificação final. |
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-modified/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-modified/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-modified/http-response.adoc[]
14.1.4. Requisitar Produtos Vendidos Devolvidos
GET /sales/returned
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Vendidos Devolvidos e faz uso dos seguintes campos para requisição.
14.1.5. Campos para Requisição
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-lista-devolvidas-example/request-parameters.adoc[]
-
Caso o campo
tipoNotaFiscal
não seja informado, será utilizado o valor padrão que é1
(SAÍDA) neste caso, os CNPJs permitidos ao aplicativo serão os do destinatário no retorno da consulta. Caso seja passado o valor0
(ENTRADA) os CNPJs do aplicativo serão os do emitente no retorno da consulta.
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista-devolucao/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista-devolucao/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-lista-devolucao/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-not-found/http-response.adoc[]
403 Forbidden
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-sem-permissao/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-nenhum-grupo/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-mais-de-um-grupo/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-destinatarios-nulo/http-response.adoc[]
14.1.6. Requisitar Produtos Devolvidos Cancelados
GET /sales/returned/cancelled
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Devolvidos que foram cancelados.
-
Este recurso retorna dados para todos os CNPJs permitidos para a aplicação que consome o serviço.
Path | Description |
---|---|
|
Timestamp da data de cancelamento inicial. Caso não seja informada, a consulta será realizada a partir do documento com data de emissão mais antiga. |
|
Timestamp da data de cancelamento final. Caso não seja informada, a consulta será realizada até a data do documento com data de emissão mais antiga. |
|
Timestamp da data de última modificação inicial. Essa é a data em que o registro sofreu a última modificação. |
|
Timestamp da data de modificação final. |
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-devolvidas-canceladas/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-devolvidas-canceladas/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-devolvidas-canceladas/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-not-found/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-canceladas-sem-dt-cancelamento/http-response.adoc[]
14.1.7. Requisitar Produtos Devolvidos Modificados
GET /sales/returned/modified
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Devolvidos que sofreram alteração no status.
-
A data de modificação inicial e final não pode ser um período maior que 31 dias.
Path | Description |
---|---|
|
OBRIGATÓRIO. Timestamp da data de última modificação inicial. Essa é a data em que o registro sofreu a última modificação. |
|
OBRIGATÓRIO. Timestamp da data de modificação final. |
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-returned-modified/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-returned-modified/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-returned-modified/http-response.adoc[]
14.1.8. Requisitar Produtos Vendidos Cancelados
GET /sales/cancelled
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Produtos Vendidos que foram cancelados.
-
Este recurso não prevê o envio de emitentes específicos e retorna dados para todos os CNPJs permitidos para a aplicação que consome o serviço.
-
Além dos parâmentros de paginação, ao menos um dos seguintes parâmetros é obrigatório e deve ser informado para este recurso:
Path | Description |
---|---|
|
Timestamp da data de cancelamento inicial. Caso não seja informada, a consulta será realizada a partir do documento com data de emissão mais antiga. |
|
Timestamp da data de cancelamento final. Caso não seja informada, a consulta será realizada até a data do documento com data de emissão mais antiga. |
|
Timestamp da data de última modificação inicial. Essa é a data em que o registro sofreu a última modificação. |
|
Timestamp da data de modificação final. |
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-canceladas/http-request.adoc[]
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-canceladas/curl-request.adoc[]
200 OK
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-retornar-canceladas/http-response.adoc[]
404 Not Found
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-error-not-found/http-response.adoc[]
400 Bad Request
Unresolved directive in salesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/salesItem/sales-canceladas-sem-dt-cancelamento/http-response.adoc[]
14.2. Campos retornados
Os campos a seguir representam o retorno de todos os recursos aqui descritos.
Path | Type | Description |
---|---|---|
|
|
Código EAN comercializado. |
|
|
Quantidade Comercializada. |
|
|
Código EAN Tributado. |
|
|
Quantidade tributada. |
|
|
Código do produto presente na NF-e normalizado (será o EAN tributado se ele existir, caso contrário o EAN comercializado. Se nenhum dos dois existirem, será uma concatenação do CNPJ do emitente com o código do produto). |
|
|
Quantidade Comercializada na NF-e (segue a regra de prodId acima para quantidade). |
|
|
Código Fiscal de Operações e Prestações. |
|
|
Dados do emitente da NF-e. |
|
|
Documento (CPF/CNPJ) referente ao emitente. |
|
|
Razão social do emitente. |
|
|
Nome fantasia do emitente. |
|
|
País de origem do emitente da NF-e. |
|
|
Código IBGE do país do emitente. |
|
|
CEP do emitente da NF-e. |
|
|
Número de telefone do emitente da NF-e. |
|
|
UF do emitente. |
|
|
Logradouro do endereço do emitente. |
|
|
Número do endereço do emitente. |
|
|
Nome do município do emitente. |
|
|
Código IBGE do município do emitente. |
|
|
Bairro do endereço do emitente. |
|
|
Complemento ao endereço do emitente. |
|
|
Dados do destinatário da NF-e. |
|
|
Documento (CPF/CNPJ) referente ào Destinatário. |
|
|
Razão social do destinatário. |
|
|
Nome fantasia do destinatário. |
|
|
Nome do país do destinatário. |
|
|
Código IBGE do país do destinatário. |
|
|
CEP do destinatário. |
|
|
Número de telefone do destinatário. |
|
|
UF do destinatário. |
|
|
Logradouro do endereço do destinatário. |
|
|
Número do endereço do destinatário. |
|
|
Nome do município do destinatário. |
|
|
Código IBGE do município do destinatário. |
|
|
Bairro do destinatário. |
|
|
Complemento ao endereço do destinatário. |
|
|
Dados de entrega. |
|
|
Documento (CPF/CNPJ) referente à entrega. |
|
|
UF da entrega. |
|
|
Logradouro da entrega. |
|
|
Número do endereço de entrega. |
|
|
Nome do município da entrega. |
|
|
Código IBGE do município da entrega. |
|
|
Bairro da entrega. |
|
|
Complemento ao endereço de entrega. |
|
|
Timestamp contendo data e hora da emissão da NF-e. |
|
|
Timestamp contendo data e hora da validação da NF-e na SEFAZ. |
|
|
Número da NF-e. |
|
|
Indicação de operação com o consumidor final (0 - Não; 1 - Consumidor Final). |
|
|
Finalidade da emissão da NF-es (1 - NF-e normal; 2 - NF-e complementar; 3 - NF-e de Ajuste; 4 - Devolução/Retorno). |
|
|
Tipo da NF-e (0 - entrada; 1 - saída). |
|
|
Status atual do item. |
|
|
IDs dos documentos fiscais aos quais o item retornado faz referência. |
|
|
ID do documento fiscal em que este item estava presente. |
|
|
Código para identificação única do item de venda. |
15. Produtos Vendidos pelo Varejo
15.1. Consulta Redes de Varejos
Permite consultar as redes de varejo cadastradas. Retorna lista de redes que o APP autenticado tem permissão.
GET /retailSales/rede
Esse recurso utiliza paginação dinâmica. |
15.1.1. Campos para requisição
Não é necessário passar nenhum campo adicional na requisição.
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-redes/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-redes/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-redes/http-response.adoc[]
15.1.2. Campos retornados
Path | Type | Description |
---|---|---|
|
|
Identificador único da rede. Esse ID é gerado no momento do cadastro do varejo |
|
|
Nome da rede de varejos |
15.2. Consulta Lojas (CNPJs)
Permite que a indústria consulte os CNPJ de todas as lojas de uma rede de varejo.
GET /retailSales/rede/cnpj?idRede=0000000001 GET /retailSales/rede/cnpj?xUF=GO GET /retailSales/rede/cnpj?xMun=Goiania GET /retailSales/rede/cnpj?xMun=São%20paulo
Esse recurso utiliza paginação dinâmica. |
15.2.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-cnpj-redes/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-cnpj-redes/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-cnpj-redes/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-cnpj-redes/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-cnpj-redes-not-found/http-response.adoc[]
15.2.2. Campos retornados
Path | Type | Description |
---|---|---|
|
|
CPF ou CNPJ do emitente |
|
|
Sigla da UF do emitente |
|
|
Nome do município do emitente |
|
|
Identificador único da rede. Esse ID é gerado no momento do cadastro do varejo |
|
|
Nome da rede de varejos |
15.3. Consulta Vendas por Período
Permite que a indústria consulte os itens vendidos por data, podendo filtrar ainda pelo CNPJ. Permite filtrar por data da venda (inicial e final). Retorna uma lista de itens vendidos incluindo a informação do IMEI. Retorna itens vendidos até no máximo três meses atrás.
15.3.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-periodo-retornar-lista/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-periodo-retornar-lista/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-periodo-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-periodo-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-periodo-error-not-found/http-response.adoc[]
15.4. Consulta Vendas por CNPJ
Permite que a indústria consulte todos os itens vendidos, podendo filtrar pelo CNPJ. Caso não seja informado o CNPJ, será retornado todas as vendas de todos os varejos em que o aplicativo tem acesso. Retorna itens vendidos até no máximo três meses atrás.
15.4.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-retornar-lista/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-retornar-lista/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-error-not-found/http-response.adoc[]
15.5. Consulta Venda por Número
Permite consultar os detalhes de uma venda específica. Na requisição deve-se informar: CNPJ do Emitente, modelo, ano, série e número da nota fiscal.
15.5.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-numero-retornar-lista/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-numero-retornar-lista/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-numero-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-numero-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-numero-not-found/http-response.adoc[]
15.6. Consulta Venda por ID
Permite consultar os detalhes de uma venda específica passando apenas o ID.
15.6.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-id-retornar-lista/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-id-retornar-lista/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-id-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-id-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-id-not-found/http-response.adoc[]
15.7. Consulta por IMEI
Permite pesquisar por um IMEI específico.
15.7.1. Campos para Requisição
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-imei-retornar-lista/request-parameters.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-imei-retornar-lista/http-request.adoc[]
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-imei-retornar-lista/curl-request.adoc[]
200 OK
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-imei-retornar-lista/http-response.adoc[]
404 Not Found
Unresolved directive in retailsalesitem-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/retailSalesItem/retail-sales-imei-not-found/http-response.adoc[]
15.8. Campos retornados
Os campos retornados abaixo se referem a todas as consultas por itens vendidos pelo varejo.
Path | Type | Description |
---|---|---|
|
|
ID composto por chaveNatural + tpAmb + nItem + tpEvento, onde a chave natural é a parte da chave de acesso suprimindo o Código Numérico e dígito verificador. Na NFe e NFCe são os primeiros 35 dígitos. No caso do SAT que é composto por 37 dígitos. O tpEvento só vai existir caso seja um cancelamento. |
|
|
1 - Produção; 2 - Homologação |
|
|
Série do Documento Fiscal. Série 890-899 de uso exclusivo para emissão de NF-e avulsa, pelo contribuinte com seu certificado digital, através do site do Fisco (procEmi=2). Série 900-999 - uso exclusivo de NF-e emitidas no SCAN. |
|
|
Número do Documento Fiscal. Está ligado diretamente à série. Sempre que a série for alterada, como por exemplo, na entrada de contingência SCAN, a numeração deve ser iniciada em "1". |
|
|
Data e Hora de emissão do Documento Fiscal (AAAA-MM-DDThh:mm:ss) ex.: 2012-09-01T13:00:00. Se não informada, será considerada a data e hora do processamento do arquivo. |
|
|
0 - entrada; 1 - saída; 9 - Cancelamento. Por padrão 1 - saída, caso não seja informada. |
|
|
1 - NF-e normal; 2 - NF-e complementar; 3 - NF-e de ajuste; 4 - Devolução / Retorno; 9 - Cancelamento |
|
|
Informar o CNPJ ou CPF do emitente. Deverá ser informado com os zeros não significativos. |
|
|
Razão Social ou nome do emitente. |
|
|
Código da UF do emitente do Documento Fiscal de acordo com a tabela do IBGE de código de unidades da federação (Tabela de UF, Município e País). |
|
|
Nome do município do emitente |
|
|
Informar o CNPJ ou CPF ou identificador de Estrangeiro do destinatário, preenchendo os zeros não significativos. Não informar o conteúdo da TAG se a operação for realizada com o exterior. Identificação do Estrangeiro não precisa ser preenchido com zeros |
|
|
Razão Social ou nome do destinatário |
|
|
Número do item (1-990) |
|
|
GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras. Preencher com o código GTIN-8, GTIN-12, GTIN-13 ou GTIN-14 (antigos códigos EAN, UPC e DUN-14), não informar o conteúdo da TAG em caso de o produto não possuir este código. |
|
|
Descrição do produto ou serviço |
|
|
Código NCM (8 posições), informar o gênero (posição do capítulo do NCM) quando a operação não for de comércio exterior (importação/exportação) ou o produto não seja tributado pelo IPI. Em caso de serviço informar o código 99. (v. 2.0) |
|
|
Código Fiscal de Operações e Prestações |
|
|
Tipo de Operação da nota. VENDA, DEVOLUCAO, TRANSFERENCIA, CANCELAMENTO. |
|
|
Unidade Comercial. Informar a unidade de comercialização do produto. |
|
|
Quantidade Comercial. Informar a quantidade de comercialização do produto. (v. 2.0). |
|
|
IMEI do item extraído do campo infAdProd. |
|
|
IMEIs extraídos dos campos infCpl e ObsCont. |
16. Noov Files
16.1. Recursos
Estes recursos permitem receber e acessar arquivos obtidos pelo serviço noov-file-watcher
.
O serviço noov-file-watcher
é um serviço a ser instalado em clientes com o objetivo de monitorar uma determinada pasta para identificar, de forma não intrusiva a criação e alteração de novos arquivos, encaminhando somente a parte alterada para esse recurso.
É responsabilidade desse recurso, manter o versionamento das alterações ocorridas nos arquivos monitorados pelo noov-file-watcher
.
É responsabilidade desses recursos organizar os arquivos de acordo com cada instância de noov-file-watcher
que esteja enviando arquivos.
16.1.1. Requisitar Lista de Instâncias
GET /files
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista das instâncias de
noov-file-watcher
que enviaram arquivos para o servidor. Como os arquivos são disponibilizados de forma hierárquica, simulando uma estrutura de pastas, o primeiro nível dessa hierarquia é a identificação da instância.
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-instances/http-request.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-instances/curl-request.adoc[]
200 OK
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-instances/http-response.adoc[]
16.1.2. Requisitar Arquivos de Instância
GET /files/{instanceId}
Esse recurso utiliza paginação dinâmica. |
-
Este recurso retorna uma lista de Meta-informações de arquivos enviados por uma determinada instância (definida em {instanceId}).
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-files/path-parameters.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-files/response-fields.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-files/http-request.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-files/curl-request.adoc[]
200 OK
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-list-files/http-response.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-instance-notfound/http-response.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-instance-notfound/http-response.adoc[]
16.1.3. Requisitar Informações de Arquivo
GET /files/{instanceId}/{originalPathHash}
-
Este recurso permite obter meta-informações do arquivo especificado em {pathHash}
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-file-info/path-parameters.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-file-info/response-fields.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-file-info/http-request.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-file-info/curl-request.adoc[]
200 OK
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-file-info/http-response.adoc[]
16.1.4. Requisitar Conteúdo de Arquivo
GET /files/{instanceId}/{pathHash}/download
-
Este recurso permite obter o conteúdo do arquivo especificado em {pathHash} na sua versão mais recente junto com suas meta-informações.
O resultado deste recurso é retornado em formato xml. |
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-download/http-request.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-download/curl-request.adoc[]
200 OK
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-download/http-response.adoc[]
16.1.5. Enviar Arquivos ao Servidor
POST /files
-
Este recurso permite que arquivos sejam enviados ao servidor. Este recurso permite recebimento de arquivos em partes, sendo que cada envio deve informar o offset dessa parte referente ao arquivo completo e o temanho dessa parte.
Fica de responsabilidade do cliente da api gerenciar os offsets das partes de arquivos enviadas ao servidor. A api não irá validar conflitos de offset durante o recebimento de arquivos. É importante manter um valor constante das partes enviadas ao servidor. |
O cliente noov-file-watcher
irá enviar o conteúdo dos arquivos separados em partes de até 10240 bytes. Em caso de alteração de arquivo, somente o conteúdo compreendido no bloco de 10240 bytes alterado será reenviado ao servidor.
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-create/http-request.adoc[]
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-create/curl-request.adoc[]
200 OK
Unresolved directive in noovfiles-service.adoc - include::/home/sartre/Documents/Sources/oobj/noov/oobj-nuvei-rest-api/target/generated-snippets/noov-files/noov-files-create/http-response.adoc[]
O valor retornado por essa requisição é um inteiro representando o CR32 calculado do conteúdo enviado. |