Documento)de)Integração!

Transcrição

1 Documento)de)Integração Web$Service$ $FLEXPAG$ Históricoderevisões Descrição Data Responsável Revisadopor Definiçãodaintrodução, 14/07/14 FelipeBonezi FelipeBonezi configuraçãoeabreviações. DefiniçãodaURIdetransação. 14/07/14 FelipeBonezi FelipeBonezi Definiçãodastabelasauxiliares 20/07/14 FelipeBonezi FelipeBonezi (i.e.bandeiraeparc.responsável) Definiçãodoretornogeradoparaa 24/07/14 FelipeBonezi FelipeBonezi requisiçãodetransação. Correçãodenamespacese 01/09/14 FelipeBonezi FelipeBonezi parâmetrosderetorno. Correçãodosparâmetrosde integraçãoobrigatóriosenãoq obrigatórios. Adiçãodenovosparâmetrosna integração. Definiçõesdospadrõesdos campos. Atualizaçãonométodode autenticaçãoparaoauth. Adicionadooscampos dddportadoretelefoneportador quefaltavam. Adicionadométododeanálisedo statusdatransação. Adicionadoseçãocom consideraçõeseformataçõesdos campos. 03/12/14 FelipeBonezi Fellipe Tenório 05/01/15 FelipeBonezi Fellipe Tenório 07/01/15 FelipeBonezi Fellipe Tenório 14/01/15 FelipeBonezi FelipeBonezi 15/01/15 FelipeBonezi FelipeBonezi 16/01/15 FelipeBonezi FelipeBonezi 20/01/15 FelipeBonezi FelipeBonezi 1

2 Introdução* Estedocumentoenglobatodaaarquiteturadeintegraçãocomoserviço daflexpagpararealizartransaçõesatravésdeclientesweb.nossoservidor utilizaaarquiteturarestapipararealizaratrocadedadosentreossistemas distribuídos. TodasasrequisiçõesdevemutilizaroprotocoloHTTPatravésdo namespacehttp://homologacao.flexpag.com:9000comorespectivouripara acessoaométododaaçãodesejada. Alémdisso,ocabeçalhodarequisiçãodeverádefinirqueoheader Content'Type=application/x'www'form'urlencoded;9charset=utf'8;,como formadedefiniçãodoparseparaocorpo i.e.bodyqdarequisição.comisso,os camposdevemserenviadosnopadrão chave=valor paraintegraçãocorreta comoserviço. Apósoenviodopacoteparaonossowebservice,omesmoirátrataras informaçõespassadaseentãoiráretornararespostanoformatojson. Autenticação* OFLEXPAGpossuimecanismodesegurançadasrequisiçõesutilizandoo cabeçalhopostparaparametrizaçãodosdadosdeautenticaçãodousuário.para tanto,énecessárioqueaintegradorapossuasuakeyesecretconfiguradae autorizadaparauso. Osistemadeintegradoradeveutilizaroseguinteformatodocabeçalho Authorization:,BASIC,BASE64(KEY:SECRET)9 ouseja,devemosconcatenarakey esecretcomdoispontosaomeioe,logoemseguida,realizarchamadapara funçãoquetransformaessesdadosconcatenadosnopadrãobase64. Exemplo KEY=9128n1kjbfj8081 SECRET=294u9nqsdnb2 Authorization:BASICOTEyOG4xa2piZmo4MDgxOjI5NHU5bnFzZG5iMg== Abreviações* JSON JavaScriptObjectNode Integradora EmpresacontratantedoserviçodaFLEXPAG 2

3 Requisições* Realizar*transação*com*Cartão*de*Crédito* URI:/web/transacao Método:POST Formatodoenvio:xQwwwQformQurlencoded Chave Descrição Tipo Obrigatória descricao Descriçãoda String S transação. numerocartao Númerodocartãode String S crédito. anovalidade Anodavalidadedo String S cartãodecrédito. mesvalidade Mêsdavalidadedo String S cartãodecrédito. codverificacao Códigodesegurança String S docartãodecrédito. bandeira Cód.dabandeirado Integer S cartão videtabela. nomeportador* Nomedoportador String S impressonocartão. cpfportador* CPFdoportadordo String S cartão. cnpjportador* CNPJdoportadordo String N cartão,casoseja cartãocoorporativoé obrigatório. parcelas Quantidadede Integer S parcelas valorbruto** Valorbruto(c/taxas) Double S datransação. valorliquido Valorlíquido(s/ Double S taxas)datransação. idrequest*** Identificadorúnico pelaintegradora. Long S parcelamentoresponsavel Tipodoparcelamento videtabela. Integer S portador* EQmaildoportadordo cartão. String S datanascimentoportador* Datanascimentodo portadordocartão. Date N logradouroportador* Logradourodo String S portadordocartão. numeroportador* Númerodo logradourodo portadordocartão. String S 3

4 complementoportador* bairroportador* cidadeportador* ufportador* cepportador* paisportador* dddportador* telefoneportador* ipportador* nomecliente* datanascimento* cpf* cnpj* ddd* telefone* * Complementodo logradourodo portadordocartão Bairrodologradouro doportadordo cartão. Cidadedologradouro doportadordo cartão. UFdacidadedo portadordocartão. CEPdologradourodo portadordocartão. Paisdacidadedo portadordocartão. DDDdotelefonedo portadordocartão. Telefonedoportador docartão. IPdocompradorque estárealizandoa transação Noteque nãoéoipdoseuweb service. Nomecompletodo clienterealizadordo pedidojuntoa integradora. Datadenascimento doclienterealizador dopedidojuntoa integradora. CPFdocliente realizadordopedido juntoaintegradora. CNPJdocliente realizadordopedido juntoaintegradora. DDDdotelefonedo clienterealizadordo pedidojuntoa integradora. Telefonedocliente realizadordopedido juntoaintegradora. EQmaildocliente realizadordopedido juntoaintegradora. String N String S String S String S String S String N String S String S String S String S Date N String N String N String S String S String S 4

5 logradouro* numero* bairro* cidade* uf* complemento* cep* pais* pedido* valorfrete* qtditens* valortotalitens* valortotalpedido* prazoentrega* Logradourodocliente realizadordopedido juntoaintegradora. Númerodoendereço doclienterealizador dopedidojuntoa integradora. Bairrodocliente realizadordopedido juntoaintegradora. Cidadedocliente realizadordopedido juntoaintegradora. Sigladoestadodo clienterealizadordo pedidojuntoa integradora vide tabela. Complementodo endereçodocliente realizadordopedido juntoaintegradora. CEPdocliente realizadordopedido juntoaintegradora. Paisdocliente realizadordopedido juntoaintegradora. Identificadordo pedidoda integradora. Valordofrete contratadopara entregadoproduto. Quantidadedeitens compradospelo comprador. Valortotaldositens compradospelo comprador. Valortotaldopedido feitopelocomprador juntoaintegradora, contendotaxasextras. Dataestimadapara entregadosprodutos compradosjuntoa integradora. String S String S String S String S String S String N String S String N String S Double N Integer N Double N Double N Date N 5

6 6 sexo Sexodocliente realizadordopedido juntoaintegradora videtabela. Integer N faixaetaria Faixaetáriadocliente realizadordopedido juntoaintegradora videtabela. String N latitude* Latitudeda solicitaçãodecompra feitapelocliente realizadordopedido juntoaintegradora. Obterdobrowser String N longitude* Longitudeda solicitaçãodecompra feitapelocliente realizadordopedido juntoaintegradora. Obterdobrowser String N *,2,Recomendado,caso,seja,utilizado,o,serviço,de,antifraude., **,2,Vide,tabela,de,fatores,enviada,pelo,setor,financeiro., ***,2,Este,número,deve,ser,gerado,pela,integradora., Retorno* *transação*com*cartão*de*crédito* Status:200<OK> Formatodoretorno:JSON Chave Descrição Tipo status Booleanoparaverificar searequisiçãodeucerto ounão. Boolean descerror Mensagemdoproblema ocorridocasoocampo status seja false. String codeerror Códigointeirodo problema. Int codigoautorizacao Códigodeautorização geradopela administradoradocartão decrédito. String data Dataregistradano webservicedatransação noformatodd/mm/yyyy. String hora Horaregistradano webservicedatransação noformatohh:mm String

7 Verificar*status*da*transação*pelo*Id*Request* URI:/web/transacaoStatus Método:POST Formatodoenvio:xQwwwQformQurlencoded Chave Descrição Tipo Obrigatória idrequest Identificadorúnico pelaintegradora. Long S Retorno* *Verificar*status*da*transação*pelo*Id*Request* Status:200<OK> Formatodoretorno:JSON Chave Descrição Tipo status Booleanoparaverificar Boolean searequisiçãodeucerto ounão. statustransacao Statusdatransaçãono String sistemadaflexpag. idrequest Códigointeirodo Int codigoautorizacao data hora problema. Códigodeautorização geradopela administradoradocartão decrédito. Dataregistradano webservicedatransação noformatodd/mm/yyyy. Horaregistradano webservicedatransação noformatohh:mm String String String cartaomascarado Cartãomascarado String utilizadonatransação. parcelas Quantidadedeparcelas Integer datransação. valortotal Valortotaldatransação. Double bandeira Identificadorda Integer bandeira. nomeportador Nomeimpressono cartãodecrédito utilizadonatransação. String descricao Descriçãodatransação. String cpfportador CPFdoportador String utilizadonatransação. telefoneportador TelefonecomDDDdo portadorutilizadona transação. String 7

8 Tabelas*Auxiliares* Bandeiras* Nome Valor Visa 1 Mastercard 2 Diners 3 AmericanExpress(AMEX) 4 Hipercard 5 ELO 9 Parcelamento*Responsável* Tipo Valor Cliente 0 Lojista 1 UF*F*Estados* Tipo Acre Alagoas Amapá Amazonas Bahia Ceará DistritoFederal EspíritoSanto Goiás Maranhão MatoGrosso MatoGrossodoSul MinasGerais Pará Paraíba Paraná Pernambuco Piauí RiodeJaneiro RioGrandedoNorte RioGrandedoSul Rondônia Roraima SantaCatarina SãoPaulo Sergipe Tocantins Valor AC AL AP AM BA CE DF ES GO MA MT MS MG PA PB PR PE PI RJ RN RS RO RR SC SP SE TO 8

9 Sexo*Cliente* Tipo Valor Feminino 0 Masculino 1 Faixa*Etária*Cliente* Tipo Valor Entre15e20anos 15Q20 Entre20e60anos 20Q50 Acimade60anos 60+ Formatações* CPF Q00 CNPJ /0000Q00 Data dd/mm/yyyyouyyyyqmmqdd IP CEP Q000 Considerações* Notequeanãoobrigatoriedadedealgunscampospoderáinfluenciarna análisedosistemadeantifraudedaflexpag.emumcenárioemqueoclienteda integradorapossuaumcartãocorporativoenãoinformeocnpjdoportador, oscoreseráafetadodiretamente. Outropontointeressanteéaquestãodaformataçãodeenviodos parâmetros,como,porexemplo,ocpfecnpj.nossosistemaestáaptoareceber essedadotantocomamáscara(i.e.xxx.xxx.xxxqxxeyy.yyy.yyy/yyyyqyy) quantoapenasnúmeros,qualquerenvioforadessesdoispadrõesserárecusado pelosservidoresdaflexpag. 9