Documento de API

Considerações Gerais

Objetivo

Enviar dados do CRM(datasul 11) para o center(umov.me).

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/utp00003sen.p.

A sintaxe para executar a API em modo persistente é:

run utp/utp00003sen.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.

Nos atributos das tabelas temporárias de entrada e saída:

ttUsuar					Entrada/Saída
Usuários do CRM para integração com UMOV.ME
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
id_Umov	Int		Id integração umov.me
active	Log		Ativo
idUsuarCrm	Int		Id crm
cdn_usuar	Char		Código usuar foundation
nom_usuario	char		Usuário
cod_e_mail_local	char		e-mail usuário

returnInteger
Requisito
Sintaxe	<Variavel integer> = returnInteger(input char).
Descrição	Retorna somente os valores numéricos de uma string
	Parâmetros	Descrição
	ctexto	texto
Retorno	ctexto

returnString
Requisito
Sintaxe	<Variavel character> = returnString(input char).
Descrição	Remove os valores numéricos da string.
	Parâmetros	Descrição
	ctexto	texto
Retorno	ctexto

getIdUmov
Requisito
Sintaxe	Run getIdUmov in handle (input char, input char, output int).
Descrição	Retorna o id do registro no umov.me.
	Parâmetros	Descrição
	cTable	Tabela
	cValue	Valor
	cIdUmov	Identificador Umov.me
Retorno	cIdUmov

createSchedule
Requisito
Sintaxe	Run createSchedule in handle (input table ttUsuar).
Descrição	Adiciona uma nova tarefa para o usuário no umov.me.
	Parâmetros	Descrição
	ttUsuar	Usuários que irão receber uma nova tarefa
Retorno

createError
Requisito
Sintaxe	Run createError in handle (input table RowErrors).
Descrição	Adiciona erro ao log de erros da integração.
	Parâmetros	Descrição
	RowErrors	erros
Retorno

createAgent
Requisito
Sintaxe	Run createAgent in handle (input table ttUsuar).
Descrição	Adiciona usuário do crm ainda não integrado ao umov.me.
	Parâmetros	Descrição
	ttUsuar	Usuários que serão adicionados no umov.me
Retorno

sendUmovMe
Requisito
Sintaxe	Run sendUmovMe in handle (input char, input char, output table ttRowErrors).
Descrição	Método principal para de integração com umov.me (criação do Schedule).
	Parâmetros	Descrição
	pUser	usuário
	pToken	token
	ttRowErrors	erros
Retorno	ttRowErrors