Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | utp\utp00218a.p |
Considerações Gerais
Objetivo
Regra de negócio para validação de tela do cadastro de aplicativo.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A sintaxe para a chamada da API é:
run utp/utp00218a.p. |
A sintaxe para executar a API em modo persistente é:
run utp/utp00218a.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
RowErrors | Entrada/Saída | ||||
Tabela de Erros | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Int |
| Sequência |
|
|
ErrorNumber | Int |
| Número |
|
|
ErrorDescription | Char |
| Descrição |
|
|
ErrorParameters | Char |
| Parâmetros |
|
|
ErrorType | Char |
| Tipo |
|
|
ErrorHelp | Char |
| Ajuda |
|
|
ErrorSubType | Char |
| Sub Tipo |
|
|
Método Negócio
getToken | ||
Requisito | [......] | |
Sintaxe | Run getToken in h-handle (input char, input char, input char, output char). | |
Descrição | Retorna o token para posterior acesso ao center umov.me. | |
Parâmetros | Descrição | |
pLogin | Login | |
pPass | Senha | |
pDomain | Domínio | |
pToken | Token | |
Retorno | pToken |
getPrograma | ||
Requisito |
| |
Sintaxe | Run getPrograma in h-handle (input int, output char). | |
Descrição | Retorna o identificador do aplicativo que será utilizado na integração com umov.me. | |
Parâmetros | Descrição | |
iNumId | Id do registro da tabela aplicat_disposit_mov | |
cProgram | Identificador do aplicativo cadastrado | |
Retorno | cProgram |
FindMessageError | ||
Requisito |
| |
Sintaxe | Run findMessageError in h-handle (input int, input char, input char, output table RowErrors). | |
Descrição | Retorna o token para posterior acesso ao center umov.me. | |
Parâmetros | Descrição | |
pi-numMsg | Código do erro | |
cparam1 | Parâmetro &1 | |
cparam2 | Parâmetro &2 | |
RowErrors | Erros | |
Retorno | RowErrors |
createLog | ||
Requisito |
| |
Sintaxe | Run createLog in h-handle (input table RowErrors). | |
Descrição | Imprime no arquivo client_log_umovme.log que será gerado no diretório temporário configurado no Progress os Erros encontrados na integração.
Observação: diretório e nome do arquivo fixo somente quando não informado pelo usuário, o método setNameLog seta o nome e diretório do log, caso não seja utilizado o default. | |
Parâmetros | Descrição | |
RowErrors | Erros | |
Retorno | RowErrors |
setNameLog | ||
Requisito |
| |
Sintaxe | Run setNameLog in h-handle (input pLogin, input pPass, input pDomain, output pToken). | |
Descrição | Set o nome e diretório do arquivo de log. | |
Parâmetros | Descrição | |
pName | Nome | |
pExt | Extensão | |
pDir | Diretório | |
Retorno |
|
setParamLog | ||
Requisito |
| |
Sintaxe | Run setParamLog in h-handle (input char, input char, input char, input char). | |
Descrição | Recebe os parâmetros para imprimir no log de integração. | |
Parâmetros | Descrição | |
P1 | Parâmetro 1 | |
P2 | Parâmetro 2 | |
P3 | Parâmetro 3 | |
P4 | Parâmetro 4 | |
Retorno |
|