Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocdp/ccapi345.p

 

Considerações Gerais

 

Objetivo

Realiza a abertura de URLs referentes ao Clicbusiness (Perfil do fornecedor, Busca de fornecedores e página informativa do Portal de compras).


Funcionamento

A API deverá ter sua execução de forma persistente sem a passagem de parâmetros. Após ser criado o handle se deve chamar as procedures específicas para cada necessidade.

A sintaxe para executar a API em modo persistente é:

run ccp/ccapi345.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.

 

Método Básico

 

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

ChamadaURLPortalDeComprasParadigma

Requisito

Nenhum

Sintaxe

Run ChamadaURLPortalDeComprasParadigma  in handle.

Descrição

Abre uma página informativa sobre o TOTVS Marketplace.

Parâmetros

Descrição

 

 

Retorno

A API irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e mensagem de erro da tentaiva de acesso. Os motivos para o erro são problemas na concexão com o portal da Clicbusiness.

ChamadaURLPerfilFornecedor

Requisito

Fornecedor previamente cadastrado no portal do Clicbusiness.

Sintaxe

Run ChamadaURLPerfilFornecedor in handle (input cnpj).

Descrição

Abre uma página apresentando o perfil do fornecedor no portal do Clicbusiness.

Parâmetros

Descrição

p-cnpj

Character X(14)

Retorno

A API irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e mensagem de erro da tentaiva de acesso. Os motivos para o erro são problemas na concexão com o portal da Clicbusiness.

ChamadaURLBuscaFornecedorClicBusiness

Requisito

Existência de uma ordem de compra ou processo de compra informados.

Sintaxe

Run ChamadaURLBuscaFornecedorClicBusiness in hadle (input p-ordem-proc, input p-tipo).

Descrição

Procedure que  realiza a busca dos fornecedores cadastrados no Clicbusiness, pela família do item da ordem informada.

Parâmetros

Descrição

p-ordem-proc

Integer – Número da ordem de compra ou processo de compra

p-tipo

Character – “ord” para uma ordem de compra  ou “proc” para um processo de compra.

Retorno

A API irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e mensagem de erro da tentaiva de acesso. Os motivos para o erro são problemas na concexão com o portal da Clicbusiness.