wiki:api_usuarios

Version 5 (modified by Santos, 8 years ago) (diff)

--

Caso FSG Colabora

API consulta

Servicio: /srv/users/getUserDataXML

Parámetros:

  • Credenciales:
    • clientId: identificador de cliente (3 para FSG)
    • userName: email del usuario que consulta
    • password: clave del usuario
    • token: credenciales encriptadas (sustituye a los 3 parámetros anteriores)
  • Específicos del servicio:
    • applicationId: identificador de la aplicación que solicita los datos (37 para la aplicación de donaciones en el entrono de pruebas)
  • Parámetros de búsqueda:
    • Nombre
    • Apellidos
    • Email
    • Sexo
    • Telefono_de_contacto
    • Profesion
    • Fecha_de_nacimiento
    • NIF_NIE_Passport
    • Direccion
    • Codigo_postal
    • Localidad
    • Pais
    • Provincia

La respuesta es xml y se ajusta al siguiente xsd: http://deve.ecliente.com/srv/users/getUserDataXML.xsd?applicationId=37

Ejemplo:

<?xml version="1.0" encoding="iso-8859-15"?>
<userData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="getUserDataXML.xsd?applicationId=37" copyright="eCliente" version="1.0" help="support@eCliente.com">
   <status>true</status>
   <auth>
      <status>true</status>
   </auth>
   <client>
      <clientId>3</clientId>
      <clientName>FSGG</clientName>
   </client>
   <user>
      <id>36155</id>
      <data id="Ficha_donaciones">
         <Nombre>Xabier</Nombre>
         <Apellidos>Vázquez</Apellidos>
         <Email>xabi@ecliente.com</Email>
         <Sexo>Hombre</Sexo>
         <Telefono_de_contacto>987654321</Telefono_de_contacto>
         <Profesion>Otros</Profesion>
         <Fecha_de_nacimiento>01/01/1970</Fecha_de_nacimiento>
         <Codigo_postal>28080</Codigo_postal>
         <Localidad>Madrid</Localidad>
         <Pais>ESPAÑA</Pais>
         <Provincia>Madrid</Provincia>
      </data>
   </user>
</userData>

API modificación/alta

Servicio: /srv/users/saveUserDataXML

Parámetros:

  • Credenciales deben ser de administrador:
    • clientId: identificador de cliente (3 para FSG)
    • userName: email del administrador
    • password: clave del administrador
    • token: credenciales encriptadas (sustituye a los 3 parámetros anteriores)
  • Específicos del servicio:
    • applicationId: identificador de la aplicación que solicita los datos (37 para la aplicación de donaciones en el entrono de pruebas)
    • userId: identificador del usuario a modificar. Si no está presente se analizan los datos. Si hay un email y existe como usuario se actualiza, si no hay email o no existe como usuario se crea el nuevo usuario.
  • Datos de usuario
    • Nombre
    • Apellidos
    • Email
    • Sexo
    • Telefono_de_contacto
    • Profesion
    • Fecha_de_nacimiento
    • NIF_NIE_Passport
    • Direccion
    • Codigo_postal
    • Localidad
    • Pais
    • Provincia

La respuesta es xml, y se ajusta al siguiente xsd: http://deve.ecliente.com/srv/users/saveUserDataXML.xsd

Ejemplo:

<?xml version="1.0" encoding="iso-8859-15"?>
<userData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="saveUserDataXML.xsd" copyright="eCliente" version="1.0" help="support@eCliente.com">
   <status>true</status>
   <auth>
      <status>true</status>
   </auth>
   <client>
      <clientId>3</clientId>
      <clientName>FSGG</clientName>
   </client>
   <user>
      <id>13583</id>
   </user>
</userData>