Árvore de páginas

Versões comparadas

Chave

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

Introdução

...

Mashups O serviço do TAS - TOTVS API Service permite a integração de qualquer aplicativo de qualquer sistema operacional e linguagem de programação. Tratasse de um Mashup, que são sites personalizados que utilizam conteúdo de mais de uma fonte para criar um serviço completo. O conteúdo de mashups geralmente são códigos de terceiros utilizados através de utilizando uma interface pública ou API.

Objetivo

...

 


Aviso
titleAtenção

Por se tratarem de serviços públicos, estamos sujeitos a mudanças de comportamento e à disponibilidade destes serviços. Sendo assim pedimos compreensão quando houver decorrência destes.

A TOTVS continuamente buscará soluções para manter a disponibilidade destes serviços, mas nos reservamos o direito de remover, a qualquer momento, sem aviso prévio, alguns dos serviços, bem como não nos responsabilizamos por qualquer prejuízo causado pelas informações ou disponibilidade dos serviços.

Adesão

...

OTOTVS 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. Mais informações sobre os serviços pagos acesse: https://www.totvs.com/totvs-api-services/

Para que o cliente posso consumir este serviço é necessário que o mesmo 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.

Para maiores informações dos serviços com consumo de consultas e os ilimitados consulte neste link.


Serviços disponíveis

...

Abaixo estão todos os serviços disponíveis para integração com o produto Datasul.

Fontes


Informações
titleMatriz de Evolução
Versão / ReleaseFuncionalidade
12.1.6Liberação de API Mashup
12.1.8Retirada necessidade de parametrização de usuário e senha pelo desenvolvedor
12.1.11Adicionada opção de proxy - IP da Totvs foi bloqueado devido a excesso de requisições
12.1.20Adicionada Consulta ao Simples Nacional
12.1.21Adicionada validação com ReCaptcha (v3.0)
12.1.2311Adicionado TOTVS API Service e alterada a arquitetura para REST

Fontes

...

<FOUNDATION>/interfac/Recaptcha: executável de exibição do ReCaptcha 3.0

<FOUNDATION>/$/FOUNDATION/Fontes_Doc/Sustentacao/V11/V11/progress/src/utp/

  • ut-mashuptas-a.p

  • ut-mashuptas-b.p

  • ut-mashuptas-banco-central.p

  • ut-mashuptas-c.p

  • ut-mashuptas-d.p

  • ut-mashuptas-e.p

  • ut-mashuptas-f.p

  • ut-mashuptas-receita.p

  • ut-tas-rest.p
  • ut-mashuptas-sintegra-captcha.p

  • ut-mashuptas-sintegra-inscricoes.p

  • ut-mashuptas-sintegra.p

  • ut-mashuptas-suframa-a.p

  • ut-mashuptas-suframa.p

  • ut-mashuptas.p

  • ut-mashuptas-tela.w


Configurações Gerais

...

Nas propriedades do sistema, em Integrações TOTVS, os seguintes parâmetros devem ser configurados:

URLÉ a URL do TOTVS API SERVICES, este parâmetro não é obrigatório, quando não preenchido assume um valor padrão. A URL inserida não deverá terminar em "/";

Chave de AcessoÉ uma chave para utilização dos serviços pagos do TOTVS API SERVICES. Mais detalhes de onde obter o token podem ser encontradas neste link.

Debug: Indica se irá gerar log de execução do serviço no debug.


Image Added



Âncora
ConfigMashup
ConfigMashup
Configuração SOAP

...

O programa utp/ut-mashup tas deve ser executado de forma persistente em uma variável HANDLE, a partir da qual serão executados os métodos de consumo dos serviços:

Bloco de código
RUN utp\/ut-mashuptas.p PERSISTENT SET hMashup.

Usuário e senha devem ser definidos para utilização dos serviços através do método SetUserPassword:

Bloco de código
RUN SetUserPassword IN hMashup(INPUT cUser, INPUT cPassword).
hTas.


Com a versão 12.1.8, não será mais necessário informar manualmente o nome de usuário e senha, será enviado automaticamente essas informações para o TOTVS API Services

A Após a configuração de usuário e senha, os serviços podem ser consumidos. A API desenvolvida retorna os dados dos serviços em formato JSON. Caso ocorra algum erro na execução do serviço, será retornado no valor "Erro", que pode ser pego através do método getString:

Bloco de código
IF oJson:getString("Erro") <> ? THEN
	cErro = oJson:getString("Erro").

Exemplos

...

Para exemplificar o consumo dos serviços oferecidos pela API desenvolvida, podem ser utilizados os exemplos abaixo:

...

Configuração REST

...

Semelhante ao modelo SOAP, no modelo REST o programa utp/ut-tas-rest deve ser executado de forma persistente em uma variável HANDLE, a partir da qual serão executados os métodos de consumo dos serviços:

Bloco de código
RUN utp/ut-tas-rest.p PERSISTENT SET hTasRest.


A API desenvolvida retorna os dados dos serviços em formato JSON. Caso ocorra algum erro na execução do serviço, será retornado no valor "Erro", que será exibido com as informações sobre o erro ocorrido.

Exemplos

...

Para exemplificar o consumo dos serviços REST oferecidos pela API desenvolvida, podem ser utilizados os exemplos abaixo: