Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice


       

Índice
exclude.*ndice:

Objetivo


       O objetivo deste documento é esclarecer sobre os serviços pagos disponíveis pelo TOTVS API Services e os pré-requisitos para requisição aos mesmos.

Introdução


       O TOTVS API Services é um serviço pago que realiza consultas em entidades públicas e os disponibiliza para qualquer solução TOTVS através de APIs padronizadas, independente do serviço público de consulta. Os serviços disponibilizados são listados abaixo e dependem do mínimo esforço para consumo dos mesmos.

Adesão


       Para que o cliente posso possa consumir este serviço é necessário que ele possua licença de algum produto TOTVS que suporte a integração com o TOTVS API Services ou que possa ser customizado . A adesão e os planos disponíveis estão disponíveis na TOTVS Store.e aderir a um dos planos disponíveis na TOTVS Store:

       Após aderir a um dos planos disponíveis, será enviada uma mensagem para o e-mail cadastrado na TOTVS Store com as instruções para continuar o cadastro.

Aviso
  • Verifique se o email de continuação do cadastro foi enviado para a caixa de SPAM.
  • No caso do não recebimento ou por eventualidade este email seja excluído, deve ser aberto um ticket ao suporte do FLUIG informando a exclusão ou não recebimento deste email solicitando o reenvio do e-mail para cadastro ao painel do manager.

      Nessa etapa, o cliente irá associar o app ou serviço adquirido na TOTVS Store a uma empresa de seu domínio. Após o preenchimento dos dados solicitados, um novo e-mail de conclusão do cadastro será enviado com o direcionamento para o Manager de Aplicativos da TOTVS.

       No Manager, o cliente deverá primeiramente selecionar a empresa associada nas etapas anteriores:

Image Added


       Em seguida, selecionar o painel "Assinatura" e nele, o plano "Totvs-api-services". Por fim, deve-se clicar no ícone de visualizar do item "Chave de autenticação (Token)" para exibir o token:

Image Added

       O Token exibido deverá ser inserido no ERP para que os serviços do TOTVS API Services disponíveis via adesão de plano sejam habilitados.


Dica

Neste link é possível acessar o ambiente para revogação ou obtenção da API-KEY (token).

Nota
titleAtenção

Consultar a linha de produto pra saber se a mesma possui suporte ao TOTVS API Services

Serviços disponíveis 


     Os serviços disponíveis pelo TOTVS API Services dependem da adesão ao Plano Pagoa algum plano na TOTVS Store. No entanto, existem alguns serviços que são disponibilizados mesmo sem a adesão a um plano, conforme detalhado abaixo.

Serviços disponíveis apenas no Plano Pago

ServiçoReceita Federal - Consulta de CNPJReceita Federal - Consulta de CPFReceita Federal - Consulta de CPF e CNPJReceita Federal - Consulta Simples NacionalReceita Federal - Consulta de NFeSintegra - Consulta Nacional ao CadastroSintegra - Consulta Unificada ao CadastroSuframa - Consulta Situação Fornecedor

disponibilizados que dependem de uma contratação à parte (Serviços de SMS). Abaixo a listagem dos serviços disponíveis:

Incluir Página
Serviços disponíveis no TAS
Serviços disponíveis no TAS

Informações

A contratação de serviços de SMS devem ser firmados com o fornecedor InfoBip.

Contato: Eduardo Araújo - [email protected]

Mais informações sobre os serviços de SMS podem ser encontradas em SMS Corporativo Via TOTVS API Services.

Configurando o TAS nos ERPs


Nos links abaixo é possível consultar como configurar e utilizar o TOTVS API Services nos ERPS TOTVS:

Protheus


RM


Datasul


Logix


Serviços de SMS (contratação à parte)

ServiçoTOTVS - Envio de SMSTOTVS - Recebimento de SMSTOTVS - Relatório Sintético de SMSTOTVS - Gerenciamento de serviços de SMS

Serviços disponíveis sem necessidade de plano

ServiçoBanco Central - Cotação de MoedasCorreios - Pesquisa de CEPCorreios - Preço e Prazo
Nota
titleAlteração dos endpoints

Para que não tenhamos quebra nas requisições existente para os serviços acima, as chamadas existentes ao Mashup não serão alteradas. Sendo necessário apenas o envio dos headers conforme descrito no tópico abaixo. 

Nota
titleDemais Serviços

Os demais serviços disponíveis no Mashup continuam com acesso livre, caso tenhamos alterações, a lista acima sofrerá revisão.

Pré-requisitos 

Para que o produto possa consumir estes serviços é necessário o envio das propriedades abaixo no header da requisição.

Abaixo as informações obrigatórias e opcionais enviadas via cabeçalho.

PropriedadeExigência Descriçãototvsmashup-api-keyObrigatório

Após adesão ao plano do TOTVS API Services, é disponibilizado para o cliente uma API KEY. Esta chave deve ser informada ao produto para que a mesma seja enviada em todas requisições realizadas ao Mashup.

 Image Removed

totvsmashup-product-nameObrigatórioO Produto envia seu nome. Ex.: (RM | PROTHEUS | DATASUL)totvsmashup-product-moduleObrigatórioO Produto envia seu módulo que está consumindo o serviço do TOTVS API Services. Ex.: (Fopxxxx | SIGAFAT)totvsmashup-customer-ls-idOpcionalO Produto envia o ID do cliente no License Server;totvsmashup-product-routineOpcionalO Produto envia sua rotina que está consumindo o serviço do TOTVS API Services. Ex.: (FopFuncAction | mata030)