A partir da lib 20250811, torna-se possível obter os dados retornados pelos serviços do TOTVS API Services (TAS) por meio da função ADVPL BlindTASExec ou via API REST APCFG10LAPI.
Essa funcionalidade permite que aplicações customizadas e integrações externas aproveitem de forma simplificada os recursos de consulta e recuperação de dados disponibilizados pelo TAS.
Importante
Apenas serviços devidamente parametrizados estarão disponíveis para consumo via função ou API REST.
Para mais detalhes sobre o processo de parametrização, consulte a seção Configuração Do Totvs Api Services.
Consumo de um serviço TAS por meio de função
A consulta de serviço TAS via função deverá ser realizada por meio da função BlindTASExec que deverá receber os seguintes parâmetros:
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cAlias | Charactere | Alias correspondente a parametrização do serviço realizada no Configurador | Sim |
| cServTas | Charactere | Nome do serviço TAS a ser consumido | Sim |
| aValBlindTas | Array | Array com os parâmetros requisitados pelo serviço, os valores devem seguir a sequencia apresentada na parametrização do serviço | Sim |
#include "protheus.ch"
/*/{Protheus.doc} TstBlindTAS
Exemplo de implementação da função BlindTASExec
@type Function
@author Bruno Pirolo
@since 05/06/2025
/*/
Function TstBlindTAS()
Local aValBlindTas as array
Local cAlias as character
Local cServTas as character
Local jBlindTasRet as json
RpcSetEnv("T1", "D MG 01")
//SOACEPService
aValBlindTas := {"03223110"}
cAlias := "SA1"
cServTas := "SOACEPService"
jBlindTasRet := BlindTASExec(cAlias, cServTas, aValBlindTas)
If jBlindTasRet["error"] == nil
VarInfo("Resultado TAS", jBlindTasRet)
Else
Conout("Erro na execução do TAS via função"+jBlindTasRet["error"])
EndIf
//BancoCentral.ConversaoMoeda
cAlias := "SA1"
cServTas := "BancoCentral.ConversaoMoeda "
aValBlindTas := {"177" /*Real*/, "61" /*Dolar EUA*/, "1", "05/06/2025"}
jBlindTasRet := BlindTASExec(cAlias, cServTas, aValBlindTas)
If jBlindTasRet["error"] == nil
VarInfo("Resultado TAS", jBlindTasRet)
Else
Conout("Erro na execução do TAS via função"+jBlindTasRet["error"])
EndIf
//SOASuframaService - Nesse exemplo é esperado um erro tratado pelo TAS e que será detalhado no error
cAlias := "SA1"
cServTas := "SOASuframaService"
aValBlindTas := {"53113791000122", "SP"}
jBlindTasRet := BlindTASExec(cAlias, cServTas, aValBlindTas)
If jBlindTasRet["error"] == nil
VarInfo("Resultado TAS", jBlindTasRet)
Else
Conout("Erro na execução do TAS via função"+jBlindTasRet["error"])
EndIf
Return
Consumo TAS via API REST
Com o mesmo objetivo da função BlindTASExec, foi disponibilizada a API APCFG10LAPI para consumo de serviços do TOTVS API Services (TAS).
Para utilizar essa API, é necessário seguir os procedimentos descritos na seção a seguir.
Parâmetro (Body)
Json contendo as seguintes propriedades
- Alias
- Tipo: String
- Descrição: Alias correspondente a parametrização do serviço realizada no Configurador.
- ServTas
- Tipo: String
- Descrição: Nome do serviço TAS a ser consumido
- ValBlindTas
- Tipo: String
- Descrição: Array com os parâmetros requisitados pelo serviço, os valores devem seguir a sequencia apresentada na parametrização do serviço
- Alias
Exemplo:
{
"Alias": "SA1",
"ServTas": "SOACEPService",
"ValBlindTas": ["03223110"]
}
Path:
api/framework/v1/apcfg10lAPI
Retorno
Json contendo todas as propriedades retornadas pelo serviço TAS consumido.
Exemplo (SOACEPService):
{
"CEP": "03223110",
"Endereço": "Rua Secundino Domingues",
"Bairro": "Jardim Independência",
"Cidade": "São Paulo",
"Estado": "SP"
}
Exemplo de consumo no Postman
