O Hub de Integração TOTVS Moda é um passo importante para a inovação a ponto de facilitar a sua integração aos diversos segmentos.
Com está nova estrutura será permitida a sua utilização para aplicações existentes ou novas de forma simples e ágil.
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.
O Token de Autorização tem a responsabilidade de autenticar os usuários nas diversas API's,
utilizamos para geração e validação de tokens no padrão Json Web Token (JWT), criptografados, que serão utilizados durante as requisições às API's,
garantindo assim, a autenticidade das informações entre as duas partes (back-end e front-end ou de um back-end para outro back-end).
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 requisições.
Trabalhando juntas e aumentando a segurança e a integridade dos seus dados.
Abaixo temos um exemplo de como gerar o Token de Autorização pelo Postman, importando através de uma cURL.
curl --location --request POST 'https://moda.api.varejo.totvs.com.br/api/totvsmoda/authorization/v2/token' \ --header 'x-api-key;' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=password' \ --data-urlencode 'client_id=' \ --data-urlencode 'client_secret=' \ --data-urlencode 'username=' \ --data-urlencode 'password=' |
---|
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.
Estrutura
A grande maioria das requisições que retornam uma coleção possuem as seguintes opções:
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
Authorization - Obter token de autorização | Documentação |
---|---|
Gerar token | Produção: https://moda.api.varejo.totvs.com.br/#/Authorization/post_api_totvsmoda_authorization_v2_token |
Accounts-receivable - Contas a receber | Documentação |
---|---|
Obter valor de limite do cliente | |
Obter dados de documentos de constas a receber | |
Obter dados de boletos já impressos | |
Liquidar faturas de contas a receber |
Analytics - Dados de movimentações fiscais | Documentação |
---|---|
Obter empresas da movimentação fiscal | |
Obter dados de comprador da movimentação fiscal | |
Obter movimentação fiscal | |
Obter dados de operação de movimentação fiscal | |
Obter dados de condição de pagamento da movimentação fiscal | |
Obter dados de pessoa da movimentação fiscal | |
Obter dados de produto da movimentação fiscal | |
Obter dados de representante da movimentação fiscal | |
Obter dados de vendedor da movimentação fiscal | |
Obter dados de tipo de saldo da movimentação fiscal |
Bank-branch - Agências bancárias | Documentação |
---|---|
Obter lista de agências bancárias | Treino: https://moda.api.varejo.totvs.com.br/treino/#/BankBranch/post_api_totvsmoda_bank_branch_v2_branches Produção: https://moda.api.varejo.totvs.com.br/#/BankBranch/post_api_totvsmoda_bank_branch_v2_branches |
Currency - Moeda | Documentação |
---|---|
Obter lista de moedas | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Currency/get_api_totvsmoda_currency_v2_currencies Produção: https://moda.api.varejo.totvs.com.br/#/Currency/get_api_totvsmoda_currency_v2_currencies |
Obter cotação de uma moeda | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Currency/get_api_totvsmoda_currency_v2_quotations Produção: https://moda.api.varejo.totvs.com.br/#/Currency/get_api_totvsmoda_currency_v2_quotations |
Data-package - Pacote de dados | Documentação |
---|---|
Obter o conteúdo de um pacote de dados | |
Incluir um pacote de dados | Produção: https://moda.api.varejo.totvs.com.br/#/DataPackage/post_api_totvsmoda_data_package_v2_input_packages |
Obter lista de pacotes de dados | Produção: https://moda.api.varejo.totvs.com.br/#/DataPackage/get_api_totvsmoda_data_package_v2_output_packages |
Alterar situação de um pacote de dados para "Recebido" | |
Obter as informações de um pacote de dados |
File - Arquivo | Documentação |
---|---|
Receber arquivo binário e retornar conteúdo codificado em Base64 com Content-Type=multipart/form-data | Treino: https://moda.api.varejo.totvs.com.br/treino/#/File/post_api_totvsmoda_file_v2_base64_content Produção: https://moda.api.varejo.totvs.com.br/#/File/post_api_totvsmoda_file_v2_base64_content |
Recebe arquivo binário e retornar conteúdo codificado em Base64 com Content-Type=application/octet-stream | Treino: https://moda.api.varejo.totvs.com.br/treino/#/File/post_api_totvsmoda_file_v2_base64_content_raw Produção: https://moda.api.varejo.totvs.com.br/#/File/post_api_totvsmoda_file_v2_base64_content_raw |
Receber um conteúdo codificado em Base64 e retorna o arquivo binário | Treino: https://moda.api.varejo.totvs.com.br/treino/#/File/post_api_totvsmoda_file_v2_binary_content Produção: https://moda.api.varejo.totvs.com.br/#/File/post_api_totvsmoda_file_v2_binary_content |
Fiscal | Documentação |
---|---|
Obter detalhe de uma item da nota fiscal | |
Obter saldo de produto em condicional por empresa e pessoa | |
Obter lista de notas fiscais e seus dados por filtro geral | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Fiscal/post_api_totvsmoda_fiscal_v2_invoices_search Produção: https://moda.api.varejo.totvs.com.br/#/Fiscal/post_api_totvsmoda_fiscal_v2_invoices_search |
Obter XML(s) de uma nota fiscal eletrônica | Produção: https://moda.api.varejo.totvs.com.br/#/Fiscal/get_api_totvsmoda_fiscal_v2_xml_contents__accessKey_ |
Location - Dados de localização | Documentação |
---|---|
Obter os dados de endereço de um CEP | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_ceps__cep_ Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_ceps__cep_ |
Obter cidade | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_city Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_city |
Obter país | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_country Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_country |
Obter estado | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Location/get_api_totvsmoda_location_v2_state Produção: https://moda.api.varejo.totvs.com.br/#/Location/get_api_totvsmoda_location_v2_state |
Image - Imagem de produto | Documentação |
---|---|
Importar imagem de produto | Treino: https://moda.api.varejo.totvs.com.br/treino/#/ProductImage/post_api_totvsmoda_image_v2_product Produção: https://moda.api.varejo.totvs.com.br/#/ProductImage/post_api_totvsmoda_image_v2_product |
Consultar imagem de produto | Produção: https://moda.api.varejo.totvs.com.br/#/ProductImage/post_api_totvsmoda_image_v2_product_search |
Management - Administração | Documentação |
---|---|
Obter parâmetros por empresa | Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_branch_parameter |
Obter parâmetros corporativos | Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_global_parameter |
Obter lista de usuários | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Management/get_api_totvsmoda_management_v2_users Produção: https://moda.api.varejo.totvs.com.br/#/Management/get_api_totvsmoda_management_v2_users |
Message - Mensagem | Documentação |
---|---|
Enviar e-mail | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Message/post_api_totvsmoda_message_v2_sendmail Produção: https://moda.api.varejo.totvs.com.br/#/Message/post_api_totvsmoda_message_v2_sendmail |
Production-order - Ordem de produção | Documentação |
---|---|
Consultar ordem de produção | Produção: https://moda.api.varejo.totvs.com.br/#/Order/post_api_totvsmoda_production_order_v2_orders_search |
Purchase-order - Pedido de compra | Documentação |
---|---|
Incluir um pedido de compra | Produção: https://moda.api.varejo.totvs.com.br/#/PurchaseOrder/post_api_totvsmoda_purchase_order_v2_orders |
Cancelar pedido de compra | |
Alterar a situação de um pedido de compra | |
Alterar a quantidade solicitada de um pedido de compra | |
Consulta pedido de compra | Produção: https://moda.api.varejo.totvs.com.br/#/PurchaseOrder/post_api_totvsmoda_purchase_order_v2_search |
Seller - Vendedor | Documentação |
---|---|
Obter lista de região de atuação de vendedores | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Seller/get_api_totvsmoda_seller_v2_operational_area Produção: https://moda.api.varejo.totvs.com.br/#/Seller/get_api_totvsmoda_seller_v2_operational_area |
Obter lista de região de atuação de vendedores por CEP | Produção: https://moda.api.varejo.totvs.com.br/#/Seller/get_api_totvsmoda_seller_v2_operational_area_cep |
Obter lista de região de atuação de vendedores por cidade | Produção: https://moda.api.varejo.totvs.com.br/#/Seller/get_api_totvsmoda_seller_v2_operational_area_city |
Obter lista de região de atuação de vendedores por estado | Produção: https://moda.api.varejo.totvs.com.br/#/Seller/get_api_totvsmoda_seller_v2_operational_area_state |
Obter lista de vendedores, empresas e clientes | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Seller/post_api_totvsmoda_seller_v2_search Produção: https://moda.api.varejo.totvs.com.br/#/Seller/post_api_totvsmoda_seller_v2_search |
Voucher | Documentação |
---|---|
Incluir um voucher | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Voucher/post_api_totvsmoda_voucher_v2_create Produção: https://moda.api.varejo.totvs.com.br/#/Voucher/post_api_totvsmoda_voucher_v2_create |
Incluir voucher para uma lista de clientes baseado em um voucher pai | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Voucher/post_api_totvsmoda_voucher_v2_customer_create Produção: https://moda.api.varejo.totvs.com.br/#/Voucher/post_api_totvsmoda_voucher_v2_customer_create |
Consultar voucher | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Voucher/get_api_totvsmoda_voucher_v2_search Produção: https://moda.api.varejo.totvs.com.br/#/Voucher/get_api_totvsmoda_voucher_v2_search |
Alterar um voucher | Treino: https://moda.api.varejo.totvs.com.br/treino/#/Voucher/post_api_totvsmoda_voucher_v2_update Produção: https://moda.api.varejo.totvs.com.br/#/Voucher/post_api_totvsmoda_voucher_v2_update |
<!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style> |