Índice | ||
---|---|---|
|
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.
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.
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 |
---|
|
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 | ||
| ||
Consultar a linha de produto pra saber se a mesma possui suporte ao TOTVS API Services |
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.
disponibilizados que dependem de uma contratação à parte (Serviços de SMS). Abaixo a listagem dos serviços disponíveis:
Incluir Página | ||||
---|---|---|---|---|
|
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.
Nos links abaixo é possível consultar como configurar e utilizar o TOTVS API Services nos ERPS TOTVS:
Nota | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
Os demais serviços disponíveis no Mashup continuam com acesso livre, caso tenhamos alterações, a lista acima sofrerá revisão. |
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.
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