...
Todas as URLs e documentações estão disponíveis no swagger de cada API disponível para acesso através dos host Base oficial ou Base treino.
Segurança
O Token de Autorização tem a responsabilidade de autenticar os usuários nas diversas API's,
...
Outro ponto importante para verificar a integridade dos dados é a chave de acesso única ou conhecido como "x-api-key",
onde este é gerado exclusivamente para cada cliente e está é obrigatório ser informando em todas as as requisições.
Trabalhando juntas e aumentando a segurança e a integridade dos seus dados.
Estrutura
A grande maioria das requisições que retornam uma coleção possuem as seguintes opções:
- page: Controle de pagina.
- page size: Controle de quantidade de coleções a serem retornadas por paginas.
- expand: Controle de quais coleções realmente precisam ser retornadas, eliminando dados desnecessários.
- limit: Indica a quantidade de recursos a serem retornados, indo de 1 e no máximo 1000 registros por páginas.
- order: Indica por qual atributo a consulta deve ser ordenada.
- max change date: Indica qual a maior data de alteração referente ao filtro realizado.
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
Abaixo temos um exemplo de como gerar o Token de Autorização pelo Postman, importando através de uma cURL.
Na aba Headers temos o campo x-api-key, onde deve ser inserida a chave de acesso única.
Na aba Body temos os campos onde devem ser inseridas as credenciais do cliente.
Image Added
Estrutura
A grande maioria das requisições que retornam uma coleção possuem as seguintes opções:
- page: Controle de pagina.
- page size: Controle de quantidade de coleções a serem retornadas por paginas.
- expand: Controle de quais coleções realmente precisam ser retornadas, eliminando dados desnecessários.
- limit: Indica a quantidade de recursos a serem retornados, indo de 1 e no máximo 1000 registros por páginas.
- order: Indica por qual atributo a consulta deve ser ordenada.
- max change date: Indica qual a maior data de alteração referente ao filtro realizado.
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
| Data-package - Pacote de dados | Documentação |
|---|
| Obter o conteúdo de um pacote de dados |
| Authorization | Documentação |
|---|
Gerar tokenAuthorizationpostauthorization_tokenAuthorizationpostauthorization_token| Accounts-receivable | Documentação |
|---|
Obter valor de limite do clienteAccountsReceivableaccountsreceivablecustomer_financial_balance_searchAccountsReceivableaccountsreceivablecustomer_financial_balance_search dados documentos constas a receberAccountsReceivablepostaccountsreceivabledocumentssearchAccountsReceivablepostaccountsreceivabledocumentssearchObter dados de boletos já impressosAccountsReceivableaccountsreceivableinvoicesprintsearchAccountsReceivableaccountsreceivableinvoicesprintsearchLiquidar faturas de contas a receberAccountsReceivablepostaccountsreceivableinvoicessettlecreateAccountsReceivablepostaccountsreceivableinvoicessettlecreateAnalytics| File - Arquivo | Documentação |
|---|
Obter empresas da movimentação fiscalAnalyticsanalyticsbranch_fiscal_movement_searchAnalyticsanalyticsbranch_fiscal_movement_searchObter dados de comprador da movimentação fiscalAnalyticsanalyticsbuyerfiscalmovement_searchAnalyticsanalyticsbuyerfiscalmovement_searchObter movimentação fiscalAnalyticsanalyticsfiscalmovement_searchAnalyticsanalyticsfiscal_movement_search dados de operação de movimentação AnalyticspostanalyticsoperationfiscalmovementAnalyticspostanalyticsoperationfiscalmovement dados de condição de pagamento da movimentação fiscalAnalyticspostanalyticspaymentfiscalmovementsearchAnalyticspostanalyticspaymentfiscalmovement_searchObter dados de pessoa da movimentação fiscalAnalyticsanalyticspersonfiscal_movement_Analyticsanalyticsperson_fiscal_movement dados de produto da movimentação fiscalAnalyticspostanalyticsproductfiscalmovementsearchAnalyticspostanalyticsproductfiscalmovement_search | General | Documentação |
|---|
| Obter dados de |
representante da movimentação fiscalAnalyticspostanalytics_v2_representative_fiscal_movement_searchAnalyticspostanalyticsrepresentative_fiscal_movement_search vendedor da movimentação fiscalAnalyticspostanalyticsseller_fiscal_movement_searchAnalyticspostanalyticsseller_fiscal_movement_searchObter dados de tipo de saldo da movimentação fiscalAnalyticsanalyticsstock_fiscal_movement_searchAnalyticsanalyticsstock_fiscal_movement_search| Data-package | Documentação |
|---|
Obter o conteúdo de um pacote de dadosDataPackagegetdata_packagecontentpackagespackageId_DataPackagegetdata_packagecontentpackagespackageId_create |
| Obter dados de uma transação |
Incluir um pacote de dadosDataPackagepostdatapackage_input_packagesDataPackagepostdata_packageinput_packagesObter lista de pacotes de dadosDataPackagegetdata_packageoutput_packagesDataPackagegetdata_packageoutput_packagesAlterar situação de um pacote de dados para "Recebido"DataPackagepostdatapackagev2outputpackagesreceiveDataPackagepostdatapackagev2outputpackagesreceive as informações de um pacote de dadosDataPackagedata_packagepackages__packageId_DataPackagedata_packagepackages__packageId_| Fiscal | Documentação |
|---|
Obter detalhe de uma item da nota fiscalFiscalfiscalinvoices_item_detail_searchFiscalfiscalinvoices_item_detail_searchObter saldo de produto em condicional por empresa e pessoaFiscalfiscalinvoices_pending_conditional_productsFiscalfiscalinvoices_pending_conditional_productsObter lista de notas fiscais e seus dados por filtro geral Fiscalfiscalinvoices_searchFiscalfiscalinvoices_searchObter XML(s) de uma nota fiscal eletrônicaFiscalgetfiscalxml_contents__accessKey_Fiscalgetfiscalxml_contents__accessKey_General | Management - Administração | Documentação |
|---|
| Obter |
dados de operaçãoGeneralgeneraloperationsGeneralgeneraloperations dados de condição de pagamentoGeneralgeneralpaymentconditionsGeneralgeneralpaymentconditions| Global | Documentação |
|---|
| Consultar CEP | Treino: Produção: |
| Consultar país | Treino: Produção: |
| Consultar estado | Treino: Produção: |
| Consultar cidade | Treino: Produção: |
| Image | Documentação |
|---|
Importar imagem de produtoProductImagepostimageproductProductImagepostimageproductConsultar imagem de produtoProductImageimageproduct_searchProductImageimageproduct_searchManagement | Person - Pessoa | Documentação |
|---|
| Obter |
parâmetros por empresaManagementmanagementbranchparameterManagementmanagementbranchparameter parâmetros corporativosManagementmanagementglobal_parameterManagementmanagementglobal_parameterObter lista de usuáriosManagementgetmanagementusersManagementgetmanagementusersPersonpersonlistbalance_bonusPersonpersonlistbalance_bonusObter os dados de recepção de vendaPersongetpersonreception_sale_searchPersongetpersonreception_sale_searchObter os dados de representantePersonpersonrepresentativessearchPersonpersonrepresentatives_search ...
