Meta. Documentación API Hackaton 100 ideas zgz

Transcripción

1 Documentación API Hackaton 100 ideas zgz Meta...1 Introducción...2 Servicio: login...3 Servicio: ciudadano...4 Servicio: tarjeta...5 Servicio: compras...6 Servicio: recargas...8 Meta Versión 1.0 Autores: Jesús Ferrero, Carlos Alocén. Fecha: 20 junio /06/17 Pág:1/9

2 Introducción La plataforma de Tarjeta Zaragoza dispone de un API de servicios para que los diferentes elementos que integra puedan realizar sus funciones de forma ágil y segura. El API de servicios proporcionado para el Hackaton de Tarjeta Zaragoza es un subconjunto de dichas llamadas, y se encuentra disponible en la URL : A continuación se describen los servicios que incluye, junto con una descripción de su función y un ejemplo de invocación. 21/06/17 Pág:2/9

3 Servicio: login Descripción: Permite obtener un token de sesión para poder realizar llamadas al API identificadorciudadano: El identificador asignado al ciudadano que hace la consulta password: El password asignado para el API Parámetros: Ninguno Devuelve: token: El token de sesión sesionfechacaducidad: Cuando expira la sesión curl -v -X GET --header 'Accept: application/json' --header 'identificadorciudadano: ' --header 'password: secreto' ' {"id":"2","identificadorciudadano":" ","token":"1225a a2a6f5b10b30f5da7 e","sesionfechacaducidad":" :00:00"} 21/06/17 Pág:3/9

4 Servicio: ciudadano Descripción: Permite obtener los datos del ciudadano que hace la llamada X-CustomToken: El token de sesión obtenido mediante la llamada al login Parámetros: identificadorciudadano Devuelve: los atributos que hay registrados para el ciudadano curl -X GET --header 'Accept: application/json' --header 'X-CustomToken: 1225a a2a6f5b10b30f5da7e' ' identificadorciudadano= ' {"id":"2","identificadorciudadano":" ","password":"secreto","nombre":"albert"," documento":" ","apellidos":"einstein","fechanacimiento":" ipotutorid":"0","tutornombre":null,"tutorapellidos":null,"tutordocumento":null,"tutorf echanacimiento":null,"tutordocumentotipoid":null,"sexo":null,"nia":null,"prueba":"\u00 00","direccionCP":null,"direccionNumero":null,"direccionPiso":null,"direccionPuerta":n ull,"direccionvia":null,"direccionlocalidad":null,"usuarioid":null,"foto":null,"identi ficadorentidadfinanciera":null,"tag":null," verificado":"\u0000","movilverificado" :"\u0000","oauth":"\u0000","accesodatos":"\u0000","token":"1225a a2a6f5b10b30f 5da7e"} 21/06/17 Pág:4/9

5 Servicio: tarjeta Descripción: Permite obtener detalles de la tarjeta de un ciudadano X-CustomToken: El token de sesión obtenido mediante la llamada al login Parámetros: identificadortarjeta: En caso de querer consultar una tarjeta específica del ciudadano, se puede solicitar por identificador mediante este parámetro. tarjetauid: En caso de querer consultar una tarjeta específica del ciudadano, se puede solicitar por uid mediante este parámetro. Devuelve: los atributos que hay registrados para la tarjeta, siempre que sea del ciudadano que hace la llamada curl -X GET --header 'Accept: application/json' --header 'X-CustomToken: 1225a a2a6f5b10b30f5da7e' ' identificadortarjeta=tz233577' {"id":"2","identificadortarjeta":"tz233577","uid":"f6f118cf","uiddecimal":" ","tarjetamodalidadid":"0","ciudadanoid":"2","tarjetacentrorecogidaid":null,"direccionn ombre":null,"direccionvia":null,"direccioncp":null,"direccionnumero":null,"direccionpi so":null,"direccionpuerta":null,"direccionlocalidad":null,"limite":null,"tag":null,"fe chacaducidad":null,"tarjetaestadoid":"0","tarjetaentregatipoid":"0","entidadfinanciera Id":null,"creditoUsado":"0.0000","saldoVirtual":"0.0000","saldoCalculado":null,"fechaS aldocalculado":null,"identificadorentidadfinanciera":null} 21/06/17 Pág:5/9

6 Servicio: compras Descripción: Permite obtener un listado de las compras realizadas por el ciudadano que hace la llamada, por varios criterios X-CustomToken: El token de sesión obtenido mediante la llamada al login Parámetros (se debe incluir al menos uno de ellos): identificadorcompra: Código único asignado a la compra ciudadanoidentificadorciudadano: Identificador del ciudadano tarjetauid: UID de la tarjeta tarjetaidentificadortarjeta: Identificador de la tarjeta Devuelve: Una lista de todas las compras registradas con los criterios de búsqueda curl -X GET --header 'Accept: application/json' --header 'X-CustomToken: 1225a a2a6f5b10b30f5da7e' ' ciudadanoidentificadorciudadano= &pagina=1&registrospagina=50' [{"id":" ","identificadorcompraexterno":" ","ident ificadorcompra":"co04b95a50","fechadescarga":" :55:47","fechaRealizacion":" :20:20","fechaRegistro":" :35:13","fechaConfirmacion":" :20:20","importe":"0.7400","operacionErronea":"\u0000","descripcion":"L\u00ednea: 042","saldoInicial":"0.7400","saldoFinal":"0.0000","tag":null,"compraAnuladaId":null," avisoid":null,"centroid":"41","dispositivoid":null,"tarjetaid":"2","ciudadanotipologia Id":null,"usuarioId":"22","anulada":"\u0000","ficheroOffline":"2134: txt ","solicitudoffline":null,"firma":"5d90da3e3f983ef7a6ce90eb823180c4752f0b58","entidadf inancieraliquidacionficheroid":"27","usoid":null,"importeoperacion":"0.7400","indiceco bro":"1.0000","traspasosaldoid":null,"ambitoliquidacionid":"82","recuperacionsaldoid": null,"productoid":null,"productobeneficioid":null,"ciudadanobonoid":null,"ciudadanoid" :"2"}, {"id":" ","identificadorcompraexterno":" ","identi ficadorcompra":"co04b95fe3","fechadescarga":" :46:25","fechaRealizacion":" :03:45","fechaRegistro":" :35:17","fechaConfirmacion":" :03:45","importe":"0.7400","operacionErronea":"\u0000","descripcion":"L\u00ednea: 033","saldoInicial":"0.7400","saldoFinal":"0.0000","tag":null,"compraAnuladaId":null," avisoid":null,"centroid":"41","dispositivoid":null,"tarjetaid":"2","ciudadanotipologia Id":null,"usuarioId":"22","anulada":"\u0000","ficheroOffline":"3561: txt ","solicitudoffline":null,"firma":"80fa65eefcba766a4f2d0e1d59283d95a9846b9a","entidadf inancieraliquidacionficheroid":"27","usoid":null,"importeoperacion":"0.7400","indiceco bro":"1.0000","traspasosaldoid":null,"ambitoliquidacionid":"82","recuperacionsaldoid": null,"productoid":null,"productobeneficioid":null,"ciudadanobonoid":null,"ciudadanoid" :"2"}, {"id":" ","identificadorcompraexterno":" ","identi ficadorcompra":"co04b9946a","fechadescarga":" :05:57","fechaRealizacion":" :18:06","fechaRegistro":" /06/17 Pág:6/9

7 22:35:15","fechaConfirmacion":" :18:06","importe":"0.7400","operacionErronea":"\u0000","descripcion":"L\u00ednea: 033","saldoInicial":"0.7400","saldoFinal":"0.0000","tag":null,"compraAnuladaId":null," avisoid":null,"centroid":"41","dispositivoid":null,"tarjetaid":"2","ciudadanotipologia Id":null,"usuarioId":"22","anulada":"\u0000","ficheroOffline":"3681: txt ","solicitudoffline":null,"firma":"dbb2c2cd80c1e8c60c d3053d4612fef3","entidadf inancieraliquidacionficheroid":"27","usoid":null,"importeoperacion":"0.7400","indiceco bro":"1.0000","traspasosaldoid":null,"ambitoliquidacionid":"82","recuperacionsaldoid": null,"productoid":null,"productobeneficioid":null,"ciudadanobonoid":null,"ciudadanoid" :"2"}, {"id":" ","identificadorcompraexterno":" ","identi ficadorcompra":"co04b9e357","fechadescarga":" :43:43","fechaRealizacion":" :31:16","fechaRegistro":" :36:14","fechaConfirmacion":" :31:16","importe":"0.7400","operacionErronea":"\u0000","descripcion":"L\u00ednea: 034","saldoInicial":"0.7400","saldoFinal":"0.0000","tag":null,"compraAnuladaId":null," avisoid":null,"centroid":"41","dispositivoid":null,"tarjetaid":"2","ciudadanotipologia Id":null,"usuarioId":"22","anulada":"\u0000","ficheroOffline":"23889: tx t","solicitudoffline":null,"firma":"9bc92a97ae7b4897b974f63b729a f6aaf","entidad FinancieraLiquidacionFicheroId":"27","usoId":null,"importeOperacion":"0.7400","indiceC obro":"1.0000","traspasosaldoid":null,"ambitoliquidacionid":"82","recuperacionsaldoid" :null,"productoid":null,"productobeneficioid":null,"ciudadanobonoid":null,"ciudadanoid ":"2"}] 21/06/17 Pág:7/9

8 Servicio: recargas Descripción: Permite obtener un listado de las recargas realizadas por el ciudadano que hace la llamada, por varios criterios X-CustomToken: El token de sesión obtenido mediante la llamada al login Parámetros (al menos uno de ellos): identificadorcompra: Código único asignado a la compra ciudadanoidentificadorciudadano: Identificador del ciudadano tarjetauid: UID de la tarjeta tarjetaidentificadortarjeta: Identificador de la tarjeta Devuelve: Una lista de todas las recargas registradas con los criterios de búsqueda curl -X GET --header 'Accept: application/json' --header 'X-CustomToken: 1225a a2a6f5b10b30f5da7e' ' ciudadanoidentificadorciudadano= &pagina=1&registrospagina=50' [{"id":" ","identificadorrecarga":"re004f210d","identificadorrecargaexterno":"78 00_ _13714","fechaDescarga":" :45:38","fechaRealizacion":" :09:59","fechaRegistro":" :33:00","fechaConfirmacion":" :09:59","importe":"5.0000","operacionErronea":"\u0000","descripcion":null,"saldoInic ial":"0.3600","saldofinal":"5.3600","tag":null,"recargaanuladaid":null,"avisoid":null, "centroid":"491","dispositivoid":"853","tarjetaid":"2","usuarioid":"22","anulada":"\u0 000","ficheroOffline":"11394:DASA_CONCILIZACION_ _ txt","solicitudOffli ne":null,"firma":"a13ff9ffe f9aa546708c6b8c0","traspasosaldoid":null,"am bitoliquidacionid":null,"recuperacionsaldoid":null,"ciudadanoid":"2"}, {"id":" ","identificadorrecarga":"re003f3554","identificadorrecargaexterno":"0 ","fechadescarga":" :00:00","fechaRealizacion":" :53:00","fechaRegistro":" :36:46","fechaConfirmacion":" :53:00","importe":" ","operacionErronea":"\u0000","descripcion":"N\u00ba m\u00e1quina recarga: 4797","saldoInicial":null,"saldoFinal":null,"tag":null,"recargaAnuladaId":null,"avisoI d":null,"centroid":"383","dispositivoid":null,"tarjetaid":"2","usuarioid":"22","anulad a":"\u0000","ficherooffline":"ciudadana_ventas_ txt","solicitudoffline":null," firma":"fb5c9cbaf8cafb6751bcb33bc06c1dd6eb856172","traspasosaldoid":null,"ambitoliquid acionid":null,"recuperacionsaldoid":null,"ciudadanoid":"2"}, {"id":" ","identificadorrecarga":"re0042fbaa","identificadorrecargaexterno":"0 ","fechadescarga":" :00:00","fechaRealizacion":" :47:00","fechaRegistro":" :36:44","fechaConfirmacion":" :47:00","importe":"5.0000","operacionErronea":"\u0000","descripcion":"N\u00ba m\u00e1quina recarga: 7096","saldoInicial":null,"saldoFinal":null,"tag":null,"recargaAnuladaId":null,"avisoI d":null,"centroid":"383","dispositivoid":null,"tarjetaid":"2","usuarioid":"22","anulad a":"\u0000","ficherooffline":"ciudadana_ventas_ txt","solicitudoffline":null," firma":"723ed0da79bb306bf087232f0cd7a285e50e45c8","traspasosaldoid":null,"ambitoliquid 21/06/17 Pág:8/9

9 acionid":null,"recuperacionsaldoid":null,"ciudadanoid":"2"}, {"id":" ","identificadorrecarga":"re0046eab9","identificadorrecargaexterno":" TZ ","fechaDescarga":" :00:00","fechaRealizacion":" :07:00","fechaRegistro":" :17:29","fechaConfirmacion":" :07:00","importe":" ","operacionErronea":"\u0000","descripcion":null,"saldoIni cial":null,"saldofinal":null,"tag":"fs","recargaanuladaid":null,"avisoid":null,"centro Id":"383","dispositivoId":"1028","tarjetaId":"2","usuarioId":"22","anulada":"\u0000"," ficherooffline":"364:ciudadana_ventas_ txt","solicitudoffline":null,"firma":"5 db4e1346dc05f e20c9d68d d4","traspasosaldoid":null,"ambitoliquidacionid": null,"recuperacionsaldoid":null,"ciudadanoid":"2"}, {"id":" ","identificadorrecarga":"re004d4a19","identificadorrecargaexterno":" ","fechaDescarga":" :21:53","fechaRealizacion":" :21:53","fechaRegistro":" :00:04","fechaConfirmacion":" :21:53","importe":" ","operacionErronea":"\u0000","descripcion":null,"saldoIni cial":"0.2100","saldofinal":" ","tag":null,"recargaanuladaid":null,"avisoid":nul l,"centroid":"383","dispositivoid":"1116","tarjetaid":"2","usuarioid":"22","anulada":" \u0000","ficherooffline":"297: txt","solicitudoffline":null,"firma":"138 29c b0ff761e811bccaf10f200c50f","traspasoSaldoId":null,"ambitoLiquidacionId":nu ll,"recuperacionsaldoid":null,"ciudadanoid":"2"}] 21/06/17 Pág:9/9