-
Notifications
You must be signed in to change notification settings - Fork 376
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d9e3402
commit f0c041d
Showing
17 changed files
with
20,123 additions
and
3 deletions.
There are no files selected for viewing
140 changes: 140 additions & 0 deletions
140
sdks/db/cached-method-objects/from-custom-request_nfe.io.yaml
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,140 @@ | ||
hash: 868fc5e77464f1f4f58166cfecdfc3e391a73644d08546efc5cffbb78a79ad74 | ||
methodObjects: | ||
- url: /v2/productinvoices/{accessKey} | ||
method: consultaByAccessKeyGet | ||
httpMethod: get | ||
tag: ProductInvoicesV2 | ||
typeScriptTag: productInvoicesV2 | ||
description: Consulta de Nota Fiscal Eletrônica na SEFAZ por Chave de Acesso | ||
parameters: | ||
- name: accessKey | ||
schema: string | ||
required: true | ||
description: Chave de Acesso | ||
example: ACCESSKEY | ||
responses: | ||
- statusCode: '200' | ||
description: '' | ||
- statusCode: '400' | ||
description: '' | ||
- statusCode: '401' | ||
description: Não autorizado, verificar o cabeçalho do HTTP Authorization | ||
- statusCode: '403' | ||
description: Accesso proibido | ||
- statusCode: '404' | ||
description: '' | ||
- statusCode: '500' | ||
description: '' | ||
- url: /v2/productinvoices/{accessKey}.pdf | ||
method: consultaPdfByAccessKey | ||
httpMethod: get | ||
tag: ProductInvoicesV2 | ||
typeScriptTag: productInvoicesV2 | ||
description: >- | ||
Consulta de Nota Fiscal Eletrônica na SEFAZ por Chave de Acesso gerando | ||
parameters: | ||
- name: accessKey | ||
schema: string | ||
required: true | ||
description: Chave de Acesso | ||
example: ACCESSKEY | ||
responses: | ||
- statusCode: '200' | ||
description: '' | ||
- statusCode: '400' | ||
description: '' | ||
- statusCode: '401' | ||
description: Não autorizado, verificar o cabeçalho do HTTP Authorization | ||
- statusCode: '403' | ||
description: Accesso proibido | ||
- statusCode: '404' | ||
description: '' | ||
- statusCode: '500' | ||
description: '' | ||
- url: /v2/productinvoices/{accessKey}.xml | ||
method: consultarNotaFiscalEletronicaPorChave | ||
httpMethod: get | ||
tag: ProductInvoicesV2 | ||
typeScriptTag: productInvoicesV2 | ||
description: Consulta de Nota Fiscal Eletrônica na SEFAZ por Chave de Acesso | ||
parameters: | ||
- name: accessKey | ||
schema: string | ||
required: true | ||
description: Chave de Acesso | ||
example: ACCESSKEY | ||
responses: | ||
- statusCode: '200' | ||
description: '' | ||
- statusCode: '400' | ||
description: '' | ||
- statusCode: '401' | ||
description: Não autorizado, verificar o cabeçalho do HTTP Authorization | ||
- statusCode: '403' | ||
description: Accesso proibido | ||
- statusCode: '404' | ||
description: '' | ||
- statusCode: '500' | ||
description: '' | ||
- url: /v2/productinvoices/events/{accessKey} | ||
method: consultarEventos | ||
httpMethod: get | ||
tag: ProductInvoicesV2 | ||
typeScriptTag: productInvoicesV2 | ||
description: Consulta de Eventos da Nota Fiscal Eletrônica na SEFAZ por Chave de Acesso | ||
parameters: | ||
- name: accessKey | ||
schema: string | ||
required: true | ||
description: Chave de Acesso | ||
example: ACCESSKEY | ||
responses: | ||
- statusCode: '200' | ||
description: '' | ||
- statusCode: '400' | ||
description: '' | ||
- statusCode: '401' | ||
description: Não autorizado, verificar o cabeçalho do HTTP Authorization | ||
- statusCode: '403' | ||
description: Accesso proibido | ||
- statusCode: '404' | ||
description: '' | ||
- statusCode: '500' | ||
description: '' | ||
numberOfSchemas: 17 | ||
apiDescription: > | ||
# Introducão | ||
Seja bem-vindo a documentação da API de consulta de Notas Fiscais! | ||
Nossa API foi criada utilizando o padrão REST que possibilita a integração de | ||
seu sistema ao nosso, sendo assim você também pode extender ou recriar as | ||
funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que | ||
está documentada abaixo. | ||
# Como usar a API? | ||
Logo a seguir você encontrará todos os recursos e metódos suportados pela API, | ||
sendo que essa página possibilita que você teste os recursos e métodos | ||
diretamente através dela. | ||
# Autenticação | ||
Você precisa de uma chave de API (API Key) para identificar a conta que está | ||
realizando solicitações para a API. | ||
Para isso você deve colocar sua chave de API no campo que se encontra topo | ||
desta página para que os métodos funcionem corretamente. | ||
No seu código e integração temos suporte para autenticação de diversas formas | ||
sendo eles: | ||
HTTP Header (Authorization ou X-NFEIO-APIKEY) ou HTTP Query String (api_key) | ||
nos dois modos passando o valor da sua chave de api (API Key). | ||
<!-- ReDoc-Inject: <security-definitions> --> |
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
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
Oops, something went wrong.