Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | utp\utp00003rec.p |
Considerações Gerais
Objetivo
Recebe dados do center(umov.me) e integra ao crm (Datasul 11).
Funcionamento
Na forma padrão, realiza-se a chamada por meio 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/utp00003rec.p. |
A sintaxe para executar a API em modo persistente é:
run utp/utp00003rec.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 |
|
|
ttUsuar | Entrada/Saída | ||||
Usuários do CRM para integração com UMOV.ME | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
id_Umov | Int |
| Id integração umov.me |
|
|
cdn_emitente | int |
| Emitente |
|
|
cdn_repres | char |
| representante |
|
|
cdn_usuar | Char |
| Usuário |
|
|
dat_agenda | char |
| Data da agenda |
|
|
dat_coleta | char |
| Data da coleta |
|
|
nom_razao_social | Char |
| Nome do Lead |
|
|
idi_tip_pessoa | Int |
| Tipo de conta |
|
|
nom_ender | Char |
| Endereço |
|
|
nom_telef | Char |
| Telefone |
|
|
nom_email_1 | Char |
|
|
| |
file_anexo | Char |
| Anexo |
|
|
cod_cep | Char |
| Cep |
|
|
nom_unid_federac | Char |
| UF |
|
|
nom_cidade | Char |
| Cidade |
|
|
nom_bairro | Char |
| Bairro |
|
|
nom_pais | Char |
| Pais |
|
|
c_nom_razao_social | Char |
| contato |
|
|
c_nom_telef | Char |
| Telefone contato |
|
|
c_nom_email_1 | char |
| e-mail contato |
|
|
ttIdAux | Entrada/Saída | ||||
Tabela auxiliar | Tabela auxiliar | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
id | Int |
| id |
|
|
Método Negócio
returnIdRepres | ||
Requisito |
| |
Sintaxe | <Variavel integer> = returnRepres(input char). | |
Descrição | Recebe o código do usuário e retorna o id do representante. | |
Parâmetros | Descrição | |
idUsuar | Usuário | |
Retorno | configur.des_val_configur |
receiverUmovMe | ||
Requisito |
| |
Sintaxe | Run receiverUmovMe in handle (input char, input char, input char, input char). | |
Descrição | Método principal para buscar os lead coletados no UMOV.ME e integrar ao CRM. | |
Parâmetros | Descrição | |
pLogin | Login | |
pPass | Senha | |
pDomain | dominio | |
cToken | token | |
Retorno |
|
createLead | ||
Requisito |
| |
Sintaxe | Run createLead in handle (input table ttLead). | |
Descrição | Adiciona um a um os leads coletados no UMOV.ME ao CRM. | |
Parâmetros | Descrição | |
ttLead | 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 |
|
createAtach | ||
Requisito |
| |
Sintaxe | Run createAtach in handle (input char, input int). | |
Descrição | Adiciona anexo ao cadastro do lead no crm. | |
Parâmetros | Descrição | |
cUrl | url | |
iNumIdLead | Id do lead no crm | |
Retorno |
|
createPhone | ||
Requisito |
| |
Sintaxe | Run createPhone in handle (input char, input int). | |
Descrição | Adiciona um novo telefone no CRM. | |
Parâmetros | Descrição | |
cNom_telef | telefone | |
iNumIdLead | Id lead | |
Retorno |
|
createContact | ||
Requisito |
| |
Sintaxe | Run createContat in handle (input char, input char, input char, input int, input char, input int, input int, output char). | |
Descrição | Adiciona um novo contato ao lead no CRM. | |
Parâmetros | Descrição | |
cNom_razao_social | Razão social | |
cNom_email_1 | e-mail contato | |
cNom_telef | Telefone contato | |
iTipPessoa | Tipo de pessoa | |
cDateColeta | Data da coleta | |
iUsuarResp | Usuário responsável | |
iNumIdLead | Id do lead | |
iNumIdPtoFocal | Id do contato ponto focal | |
Retorno | iNumIdPtoFocal |
createBond | ||
Requisito |
| |
Sintaxe | Run createBond in handle (input int, input int). | |
Descrição | Adiciona um novo telefone no CRM. | |
Parâmetros | Descrição | |
iNumContat | Id contato | |
iNumIdLead | Id lead | |
Retorno |
|
createAdress | ||
Requisito |
| |
Sintaxe | Run createBond in handle (input int, input int). | |
Descrição | Adiciona um novo telefone no CRM. | |
Parâmetros | Descrição | |
cNomEnder | Endereço | |
cCodCep | Cep | |
cPais | País | |
cUF | UF | |
cCidade | Cidade | |
cBairro | Bairro | |
iNumIdLead | Id lead | |
iNumIdEnder | Id ender | |
Retorno | iNumIdEnder |
createCity | ||
Requisito |
| |
Sintaxe | Run createCity in handle (input char, input int, output int). | |
Descrição | Adiciona uma nova cidade no CRM. | |
Parâmetros | Descrição | |
cNomCidade | Cidade | |
iNumUF | Id UF | |
iNumCidade | Id cidade | |
Retorno | iNumCidade |
createNeighborhood | ||
Requisito |
| |
Sintaxe | Run createNeighborhood in handle (input char, input int, output int). | |
Descrição | Adiciona um novo bairro no CRM. | |
Parâmetros | Descrição | |
cNomBairro | Bairro | |
iNumCidade | Id cidade | |
iNumBairro | Id bairro | |
Retorno | iNumBairro |
createUF | ||
Requisito |
| |
Sintaxe | Run createUF in handle (input char, input char, input int, output int). | |
Descrição | Adiciona uma nova UF no CRM. | |
Parâmetros | Descrição | |
cNomUF | UF | |
iNumPais | Id país | |
iNumUF | Id UF | |
Retorno | iNumUF |
createZipCode | ||
Requisito |
| |
Sintaxe | Run createZipCode in handle (input char, input int, input int, input char, output int). | |
Descrição | Adiciona um novo cep CRM. | |
Parâmetros | Descrição | |
cCodCep | Crp | |
iNumCidade | Id cidade | |
iNumBairro | Id bairro | |
cNomEnder | Endereço | |
iNumCep | Id cep | |
Retorno | iNumCep |
createCountry | ||
Requisito |
| |
Sintaxe | Run createUF in handle (input char, input char, input int, output int). | |
Descrição | Adiciona uma nova UF no CRM. | |
Parâmetros | Descrição | |
cNomPais | País | |
iNumPais | Id país | |
Retorno | iNumPais |