Clearsale
Classe que facilita a integração com o sistema de Web Services da Clearsale utilizando ASP 3.0.
Requirements
About
Summary
|
|
Classe que facilita a integração com o sistema de Web Services da Clearsale utilizando ASP 3.0.
|
|
|
|
|
|
URI do Web Service de entrada de dados da Clearsale.
|
|
|
URI do Web Service de retorno de dados da Clearsale.
|
|
|
Identificação de entidade no sistema Clearsale.
|
|
|
Identificação de usuário no sistema Clearsale.
|
|
|
Senha do usuário no sistema Clearsale.
|
|
|
|
|
|
Retrieve the right key for a given value in the dictionary.
|
|
|
Returns the lower case without accents version of the string.
|
|
|
Remove the XML declaration.
|
|
|
Esta função transforma o string sValue na constante equivalente “Pessoa Física/Jurídica” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante equivalente “Sexo” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante equivalente “UF” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante equivalente “Tipo de endereço” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante equivalente “Tipo de Telefone” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante equivalente “Forma de Pagamento” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante “Tipo (Bandeira) do Cartão de Crédito” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante “Tipo de entrega” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante “Pedido para presente” utilizada pela Clearsale.
|
|
|
Transforma o string sValue na constante “Status do Pedido” utilizada pela Clearsale.
|
|
|
Utiliza um objeto Xml ou um source Xml para enviar os pedidos ao web service da Clearsale.
|
|
|
Utiliza o source do Xml para enviar os pedidos ao web service da Clearsale.
|
|
|
Retorna a análise do pedido em tempo de execução.
|
|
|
Recebe os id’s dos pedidos já analisados pela Clearsale.
|
|
|
Confirma o recebimento dos id’s dos pedidos já analisados à Clearsale.
|
|
|
Retorna as análises dos pedidos.
|
|
|
Confirma o recebimento dos id’s das análises à Clearsale.
|
uriEntrada
URI do Web Service de entrada de dados da Clearsale. Este dado é fornecido pela Clearsale.
Contains
uriRetorno
URI do Web Service de retorno de dados da Clearsale. Este dado é fornecido pela Clearsale.
Contains
entidade
Identificação de entidade no sistema Clearsale. Este dado é fornecido pela Clearsale.
Contains
usuario
Identificação de usuário no sistema Clearsale. Este dado é fornecido pela Clearsale.
Contains
senha
Senha do usuário no sistema Clearsale. Este dado é fornecido pela Clearsale.
Contains
|
(string)
|
Senha do usuário
|
findKey
|
private function findKey(
|
Sd,
|
|
sValue
|
)
|
|
Retrieve the right key for a given value in the dictionary.
Parameters
|
(scripting.dictionary)
|
The options dictionary
|
|
(string)
|
The value
|
Returns
|
(string)
|
The key that contains the value
|
lCaseNoAccent
|
private function lCaseNoAccent(
|
sValue
|
)
|
|
Returns the lower case without accents version of the string.
Parameters
|
(string)sValue
|
Texto a ser transformado
|
Returns
|
(string)
|
Texto no formato lower case e sem acentuação
|
stripXmlDeclaration
|
private function stripXmlDeclaration(
|
sXml
|
)
|
|
Remove the XML declaration.
Parameters
Returns
|
(string)
|
XML Source without the Xml declaration
|
getTpPessoa
|
public function getTpPessoa(
|
sValue
|
)
|
|
Esta função transforma o string sValue na constante equivalente “Pessoa Física/Jurídica” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
{ ‘F’, ‘J’, “FISICA”, “JURIDICA”, “FÍSICA”, “JURÍDICA” }
|
Returns
|
-1
|
Tipo de pessoa não pode ser detectado
|
|
1
|
Pessoa física
|
|
2
|
Pessoa jurídica
|
getSexo
|
public function getSexo(
|
sValue
|
)
|
|
Transforma o string sValue na constante equivalente “Sexo” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
{ ‘M’, ‘F’, “MASC”, “FEM”, “MASCULINO”, “FEMININO” }
|
Returns
|
-1
|
Tipo de sexo não pode ser identificado
|
|
M
|
Sexo masculino
|
|
F
|
Sexo feminino
|
getUf
|
public function getUf(
|
sValue
|
)
|
|
Transforma o string sValue na constante equivalente “UF” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Estado brasileiro no formato completo (com ou sem acentuação), ou sigla equivalente.
|
Returns
|
-1
|
Unidade Federativa não pode ser detectada
|
|
(string)
|
Sigla da unidade federativa em caixa alta
|
getTpEndereco
|
public function getTpEndereco(
|
sValue
|
)
|
|
Transforma o string sValue na constante equivalente “Tipo de endereço” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Tipo de endereço. Ex.: Comercial, Residencial, Cobrança, etc.
|
Returns
|
-1
|
Tipo de endereço não encontrado
|
|
(int)
|
Constante tipo de endereço equivalente
|
getTpTelefone
|
public function getTpTelefone(
|
sValue
|
)
|
|
Transforma o string sValue na constante equivalente “Tipo de Telefone” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Tipo de telefone. Ex. Cobrança, Temporário
|
Returns
|
-1
|
Tipo de endereço não encontrado
|
|
(int)
|
Constante tipo de telefone equivalente
|
getFormaPagamento
|
public function getFormaPagamento(
|
sValue
|
)
|
|
Transforma o string sValue na constante equivalente “Forma de Pagamento” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Forma de pagamento. Ex. Cartão de crédito, Boleto Bancário, etc
|
Returns
|
-1
|
Forma de pagamento não encontrada
|
|
(int)
|
Constante forma de pagamento equivalente
|
getTpBandeira
|
public function getTpBandeira(
|
sValue
|
)
|
|
Transforma o string sValue na constante “Tipo (Bandeira) do Cartão de Crédito” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Bandeira. Ex. Diners, Master, Visa, etc
|
Returns
|
-1
|
Bandeira não encontrada
|
|
(int)
|
Constante tipo (bandeira) do cartão de crédito equivalente
|
getTpEntrega
|
public function getTpEntrega(
|
sValue
|
)
|
|
Transforma o string sValue na constante “Tipo de entrega” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Forma de entrega. Ex. Diners, Master, Visa, etc
|
Returns
|
-1
|
Tipo de entrega não encontrada
|
|
(int)
|
Constante tipo (bandeira) do cartão de crédito equivalente
|
paraPresente
|
public function paraPresente(
|
sValue
|
)
|
|
Transforma o string sValue na constante “Pedido para presente” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
{ “SIM”, “NÃO”, “TRUE”, “FALSE “}
|
Returns
|
-1
|
Impossível determinar por valor fornecido
|
|
0
|
Não, false
|
|
1
|
Sim, true
|
getStatusPedido
|
public function getStatusPedido(
|
sValue
|
)
|
|
Transforma o string sValue na constante “Status do Pedido” utilizada pela Clearsale.
Parameters
|
(string)sValue
|
Status do pedido. Ex. Novo, Cancelado, Aprovado, etc
|
Returns
|
-1
|
Status do pedido inválido
|
|
(int)
|
Constante status do pedido equivalente
|
postPedidos
|
public function postPedidos(
|
Xml
|
)
|
|
Utiliza um objeto Xml ou um source Xml para enviar os pedidos ao web service da Clearsale.
Parameters
|
(string|object)Xml
|
Objeto XML com os dados dos pedidos
|
Returns
|
-1
|
Problemas com o Xml
|
|
true
|
Operação realizada com sucesso
|
|
false
|
Caso contrário
|
See also
postPedidosStr
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim bValue : bValue = Cs.postPedidos(Server.mapPath("pedidos.xml"))
if(bValue) then
Response.write "Pedidos enviados com sucesso."
else
Response.write "Problemas no envido de pedidos."
end if
set Cs = nothing
postPedidosStr
|
public function postPedidosStr(
|
sXml
|
)
|
|
Utiliza o source do Xml para enviar os pedidos ao web service da Clearsale.
Parameters
|
(string)sXml
|
Source do XML com os dados dos pedidos
|
Returns
|
true
|
Operação realizada com sucesso
|
|
false
|
Caso contrário
|
See also
postPedidos
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim bValue : bValue = Cs.postPedidosStr("<clearsale><pedido>...</pedido><pedido>...</pedido></clearsale>")
if(bValue) then
Response.write "Pedidos enviados com sucesso."
else
Response.write "Problemas no envido de pedidos."
end if
set Cs = nothing
getAnalisePedido
|
public function getAnalisePedido(
|
sXml
|
)
|
|
Retorna a análise do pedido em tempo de execução.
Parameters
|
(string)sXml
|
Source do XML com os dados do pedido
|
Returns
|
(string)
|
Resultado da análise
|
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim sValue : sValue = Cs.getAnalisePedido("<clearsale><pedido>...</pedido></clearsale>")
if( len(sValue) > 0 ) then
dim Xml, XmlErr : set Xml = Server.createObject("MSXML2.DOMDocument.6.0")
Xml.loadXml(sValue)
if( Xml.parseError.errorCode <> 0 ) then
set XmlErr = Xml.parseError
Response.write "Error while parsing XML data: " & ErrXml.reason
Response.end
set XmlErr = nothing
end if
set Xml = nothing
else
Response.write "Problemas na análise do pedido."
end if
set Cs = nothing
'Use the Xml object here. Xml content example:
'<?xml version="1.0"?>
'<clearsale>
' <pedido>
' <codigo>300268</codigo>
' <usuario>admin</usuario>
' <status>9</status>
' <score>4,839871</score>
' <diagnostico>
' Valor do Pedido - Categoria 4
' Domínio do Provedor do E-mail Categoria 13
' </diagnostico>
' <sequencia>1</sequencia>
' <total>3122</total>
' <lote>5</lote>
' <solicitacao>14/02/2006 10:32:03</solicitacao>
' </pedido>
'<clearsale>
getAnalisados
|
public function getAnalisados(
|
iTipo,
|
|
iLimite
|
)
|
|
Recebe os id’s dos pedidos já analisados pela Clearsale.
Parameters
|
(int)iTipo
|
Tipo de retorno pretendido. (Atualmente, apenas tipo 1 está implementado)
|
|
(int)iLimite
|
Maximo de pedidos que devem ser retornados. (Valor máximo é 200)
|
Returns
|
(string)
|
Source do XML contendo a informação dos pedidos analisados.
|
See also
setAnalisadosRecebidos
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim sValue : sValue = Cs.getAnalisados(1, 200)
if( len(sValue) > 0 ) then
dim Xml, XmlErr : set Xml = Server.createObject("MSXML2.DOMDocument.6.0")
Xml.loadXml(sValue)
if( Xml.parseError.errorCode <> 0 ) then
set XmlErr = Xml.parseError
Response.write "Error while parsing XML data: " & ErrXml.reason
Response.end
set XmlErr = nothing
end if
set Xml = nothing
else
Response.write "Problemas no retorno do método getAnalisados."
end if
set Cs = nothing
'Use the Xml object here. Xml content example:
' <?xml version="1.0"?>
' <entidade>
' <nrpedido>00001</nrpedido>
' <nrpedido>00002</nrpedido>
' <nrpedido>00003</nrpedido>
' .
' .
' .
' </entidade>
setAnalisadosRecebidos
|
public function setAnalisadosRecebidos(
|
scsvId
|
)
|
|
Confirma o recebimento dos id’s dos pedidos já analisados à Clearsale. Assim você não receberá os id’s novamente em uma próxima chamada do getAnalisados.
Parameters
|
(string)scsvId
|
id’s dos pedidos separados pelo símbolo ponto e vírgula
|
Returns
|
(int)
|
Quantidade de id’s recebidos
|
See also
getAnalisados
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim sValue : sValue = Cs.getAnalisados(1, 200)
if( len(sValue) > 0 ) then
dim Xml, XmlErr : set Xml = Server.createObject("MSXML2.DOMDocument.6.0")
Xml.loadXml(sValue)
if( Xml.parseError.errorCode <> 0 ) then
set XmlErr = Xml.parseError
Response.write "Error while parsing XML data: " & ErrXml.reason
Response.end
set XmlErr = nothing
end if
set Xml = nothing
else
Response.write "Problemas na requisição getAnalisados."
end if
dim sRecebidos : sRecebidos = ""
dim Nodelist, Node : set Nodelist = Xml.selectNodes("/entidade/nrpedido")
for each Node in Nodelist
sRecebidos = sRecebidos & Node.text & ";"
next
set Node = nothing
set Nodelist = nothing
sRecebidos = left(sRecebidos, len(sRecebidos) - 1)
Cs.setAnalisadosRecebidos(sRecebidos)
set Cs = nothing
'Use the Xml object here. Xml content example:
' <?xml version="1.0"?>
' <entidade>
' <nrpedido>00001</nrpedido>
' <nrpedido>00002</nrpedido>
' <nrpedido>00003</nrpedido>
' .
' .
' .
' </entidade>
getAnalises
|
public function getAnalises(
|
iTipo,
|
|
iLimite
|
)
|
|
Retorna as análises dos pedidos.
Parameters
|
(int)iTipo
|
n E {0, 1, 2, 3, 4, 5}
|
|
(int)iLimite
|
Maximo de análises que devem ser retornadas. (Valor máximo é 200)
|
Returns
|
(string)
|
Source do XML contendo a informação das analises.
|
See also
setAnalisesRecebidas
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim sValue : sValue = Cs.getAnalises(4, 200)
if( len(sValue) > 0 ) then
dim Xml, XmlErr : set Xml = Server.createObject("MSXML2.DOMDocument.6.0")
Xml.loadXml(sValue)
if( Xml.parseError.errorCode <> 0 ) then
set XmlErr = Xml.parseError
Response.write "Error while parsing XML data: " & ErrXml.reason
Response.end
set XmlErr = nothing
end if
set Xml = nothing
else
Response.write "Problemas na requisição getAnalises."
end if
set Cs = nothing
'Use the Xml object here. Xml content example:
' <?xml version="1.0"?>
' <clearsale>
' <pedido>
' <codigo>300268</codigo>
' <usuario>admin</usuario>
' <status>9</status>
' <score>4,839871</score>
' <diagnostico>
' Valor do Pedido - Categoria 4
' Domínio do Provedor do E-mail Categoria 13
' </diagnostico>
' <sequencia>1</sequencia>
' <total>3122</total>
' <lote>5</lote>
' <solicitacao>14/02/2006 10:32:03</solicitacao>
' </pedido>
' <pedido>
' .
' .
' .
' </pedido>
'<clearsale>
setAnalisesRecebidas
|
public function setAnalisesRecebidas(
|
scsvId
|
)
|
|
Confirma o recebimento dos id’s das análises à Clearsale. Assim você não receberá os id’s novamente em uma próxima chamada do getAnalises.
Parameters
|
(string)scsvId
|
id’s dos pedidos separados pelo símbolo ponto e vírgula
|
Returns
|
(int)
|
Quantidade de id’s recebidos
|
See also
getAnalises
Example
dim Cs : Cs = new Clearsale
Cs.entidade = "entity"
Cs.usuario = "user"
Cs.senha = "password"
dim sValue : sValue = Cs.getAnalises(4, 200)
if( len(sValue) > 0 ) then
dim Xml, XmlErr : set Xml = Server.createObject("MSXML2.DOMDocument.6.0")
Xml.loadXml(sValue)
if( Xml.parseError.errorCode <> 0 ) then
set XmlErr = Xml.parseError
Response.write "Error while parsing XML data: " & ErrXml.reason
Response.end
set XmlErr = nothing
end if
set Xml = nothing
else
Response.write "Problemas na requisição getAnalises."
end if
dim sRecebidos : sRecebidos = ""
dim Nodelist, Node : set Nodelist = Xml.selectNodes("/clearsale/pedido/codigo")
for each Node in Nodelist
sRecebidos = sRecebidos & Node.text & ";"
next
set Node = nothing
set Nodelist = nothing
sRecebidos = left(sRecebidos, len(sRecebidos) - 1)
Cs.setAnalisesRecebidas(sRecebidos)
set Cs = nothing
'Use the Xml object here. Xml content example:
' <?xml version="1.0"?>
' <clearsale>
' <pedido>
' <codigo>300268</codigo>
' <usuario>admin</usuario>
' <status>9</status>
' <score>4,839871</score>
' <diagnostico>
' Valor do Pedido - Categoria 4
' Domínio do Provedor do E-mail Categoria 13
' </diagnostico>
' <sequencia>1</sequencia>
' <total>3122</total>
' <lote>5</lote>
' <solicitacao>14/02/2006 10:32:03</solicitacao>
' </pedido>
' <pedido>
' .
' .
' .
' </pedido>
'<clearsale>
|