Web service com.senior.g5.co.int.varejo.autenticadores
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_int_varejo_autenticadores?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_autenticadores?wsdl
- Agendado: http://example.com/http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_int_varejo_autenticadores?wsdl
Porta(s)
Exportar 2
Porta para exportação de cadastro de autenticadores externos de clientes.
Necessita autenticação: Sim.
Situação da versão: Atual
Versão: 2.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <Consulta> <CodAec>Integer</CodAec> </Consulta> <CodFil>Integer</CodFil> <TipoIntegracao>String</TipoIntegracao> <IdentificadorSistema>String</IdentificadorSistema> <QuantidadeRegistros>Integer</QuantidadeRegistros> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
CodEmp | Obrigatório | Integer | (Obrigatório) - Number(004) - Código da Empresa. |
CodFil | Obrigatório | Integer | (Obrigatório) - Number(005) - Código da Filial. |
TipoIntegracao | Obrigatório | String | (Obrigatório) - String(001) - Tipo de Integração. Lista: T = Todos; A = Somente Alterados; E = Registro Específico. |
IdentificadorSistema | Obrigatório | String | (Obrigatório) - String(15) - Identificação do sistema integrado. |
QuantidadeRegistros | Opcional | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
Consulta | Opcional | Set | (Opcional) - Utilizar para informar quais registros específicos devem ser retornados. Obrigatório quando TipoIntegracao for "E". |
Consulta.CodAec | Obrigatório | Integer | (Obrigatório) - Number(004) - Código do autenticador externo de crédito de clientes para consulta - Obrigatório se tipo de consulta = E. |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarResponse> <result> <Autenticador> <seqInt>Integer</seqInt> <codAec>Integer</codAec> <desAec>String</desAec> <fmtAec>Integer</fmtAec> <diaAec>Integer</diaAec> <sitAec>String</sitAec> <tipAec>Integer</tipAec> <usuAec>String</usuAec> <senAec>String</senAec> <consultas> <ideUni>Integer</ideUni> <codCae>Integer</codCae> <desCae>String</desCae> <disFis>Integer</disFis> <disJur>Integer</disJur> <urlSec>String</urlSec> <tplReq>String</tplReq> <tplRes>String</tplRes> </consultas> <usuarios> <codUsu>Integer</codUsu> <usrTtm>String</usrTtm> <senTtm>String</senTtm> </usuarios> </Autenticador> <GridErros> <msgErr>String</msgErr> </GridErros> <finalizaramRegistros>String</finalizaramRegistros> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
Autenticador | Opcional | Set | (Opcional) - Lista de autenticadores encontrados. |
Autenticador.SeqInt | Obrigatório | Integer | (Obrigatório) - Number(009) - Código Sequencial do Registro. |
Autenticador.CodAec | Obrigatório | Integer | (Obrigatório) - Number(004) - Código do autenticador externo de crédito de clientes. |
Autenticador.DesAec | Obrigatório | String | (Obrigatório) - String(100) - Descrição do autenticador externo de crédito de clientes. |
Autenticador.FmtAec | Obrigatório | Integer | (Obrigatório) - Number(001) - Formato do autenticador externo de crédito. Lista: 1 = Venda; 2 = Cliente. |
Autenticador.DiaAec | Opcional | Integer | (Opcional) - Number(004) - Quantidade de dias de validade da autenticação realizada para análise crédito. |
Autenticador.SitAec | Obrigatório | String | (Obrigatório) - String(001) - Situação do autenticador externo de crédito. Lista: A = Ativo; I = Inativo. |
autenticador.tipAec | Opcional | Integer | Tipo do Autenticador de crédito (1 = IBRATAN, 2 = SPC, 3= SERACA, 4 = Regra Interna) |
autenticador.usuAec | Opcional | String | Usuário no autenticador externo |
autenticador.senAec | Opcional | String | Senha de autenticação |
consultas | Opcional | Set | Lista de consultas disponíveis para o autenticador |
consultas.ideUni | Opcional | Integer | Identificador único da consulta |
consultas.codCae | Opcional | Integer | Código da consulta do autenticador |
consultas.desCae | Opcional | String | Descrição da consulta do autenticador |
consultas.disFis | Opcional | Integer | Indicativo se a consulta está disponível para pessoa física |
consultas.disJur | Opcional | Integer | Indicativo se a consulta está disponível para pessoa jurídica |
consultas.urlSec | Opcional | String | URL dos serviços da consulta no autenticador |
consultas.tplReq | Opcional | String | Template Html da Requisição (será utilizado para executar a consulta no sistema de retaguarda) |
consultas.tplRes | Opcional | String | Template Html da Requisicao (será utilizado para a visualização da consulta no sistema de retaguarda) |
usuarios | Opcional | Set | Usuários de acesso |
usuarios.codUsu | Opcional | Integer | Código do usuário |
usuarios.usrTtm | Opcional | String | Código do Usuário no autenticador externo |
usuarios.senTtm | Opcional | String | Senha do Usuário no autenticador externo |
GridErros | Opcional | Set | (Opcional) - Lista de erros. |
GridErros.MsgErr | Obrigatório | String | (Obrigatório) - String - Mensagem de erro. |
FinalizaramRegistros | Obrigatório | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas. Lista: S = Sim, N = Não. |
TipoRetorno | Obrigatório | Integer | (Obrigatório) - Number(001) - Tipo de Retorno do Processamento. Lista: 1 = Processado, 2 = Erro na Solicitação. |
MensagemRetorno | Obrigatório | String | (Obrigatório) - String - Mensagem de Retorno do Processamento. |
NumeroLote | Obrigatório | Integer | (Obrigatório) - Number(001) - Identificação do Lote de Exportação. Opcional se não existirem registros para exportar. |
erroExecucao | Opcional | String |
ConsultarAutenticadoresCliente
Esta porta executará um serviço de autenticador externo de cliente. Ela receberá uma requisição de consulta de cliente que executará todos os autenticadores de clientes que foram informados na lista de autenticadores.
Necessita autenticação: Sim.
Situação da versão: Atual
Versão: 1.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarAutenticadoresCliente> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <Autenticadores> <CodAec>Integer</CodAec> </Autenticadores> <CodFil>Integer</CodFil> <CodCli>Integer</CodCli> <IdentificadorSistema>String</IdentificadorSistema> </parameters> </ser:ConsultarAutenticadoresCliente> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
CodEmp | Obrigatório | Integer | (Obrigatório) - Number(004) - Código da Empresa. |
CodFil | Obrigatório | Integer | (Obrigatório) - Number(005) - Código da Filial. |
CodCli | Obrigatório | Integer | (Obrigatório) - Number(009) - Código do Cliente. |
IdentificadorSistema | Obrigatório | String | (Obrigatório) - String(15) - Identificação do sistema integrado. |
Autenticadores | Obrigatório | Set | Lista de autenticadores que serão consultados |
Autenticadores.CodAec | Obrigatório | Integer | (Opcional) - Number(004) - Código do autenticador externo de crédito de clientes. |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarAutenticadoresClienteResponse> <result> <Retorno> <CodAec>Integer</CodAec> <SeqRac>Integer</SeqRac> <DatRac>DateTime</DatRac> <SitRac>String</SitRac> <DesRac>String</DesRac> <MotSit>String</MotSit> <ParAna>String</ParAna> </Retorno> <Erros> <MsgErr>String</MsgErr> </Erros> <TipoRetorno>Integer</TipoRetorno> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarAutenticadoresClienteResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
Retorno | Opcional | Set | Lista com retorno da consulta |
Retorno.CodAec | Obrigatório | Integer | (Obrigatório) - Number(004) - Código do autenticador externo de crédito de clientes. |
Retorno.SeqRac | Obrigatório | Integer | (Obrigatório) - Number(004) - Sequência do retorno do autenticador externo de crédito de cliente. |
Retorno.DatRac | Obrigatório | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data do retorno do autenticador externo de crédito de cliente. |
Retorno.SitRac | Obrigatório | String | (Obrigatório) - String(001) - Situação do Retorno. Lista: A = Aprovado; R = Reprovado; N = Não analisado; I = Ignorado; E = Erro; C = Contingência. |
Retorno.DesRac | Opcional | String | (Opcional) - String(2500) - Descrição do retorno do autenticador externo de crédito de cliente. |
Retorno.MotSit | Opcional | String | (Opcional) - String(255) - Descrição do motivo da situação. |
Retorno.ParAna | Opcional | String | (Opcional) - String(255) - Descrição do parecer do analista. |
Erros | Opcional | Set | (Opcional) - Lista de erros |
Erros.MsgErr | Obrigatório | String | (Obrigatório) - String - Mensagem de erro. |
TipoRetorno | Obrigatório | Integer | (Obrigatório) - Number(001) - Tipo de Retorno do Processamento. Lista: 1 = Processado, 2 = Erro na Solicitação. |
MensagemRetorno | Obrigatório | String | (Obrigatório) - String - Mensagem de Retorno do Processamento. |