Navegación




Búsqueda en la Ayuda

Usuario

A continuación describimos las llamadas a la API para obtener información referente a los usuarios.

Os recordamos que SIEMPRE debéis incluir la ApiKey. (NOTA: En los ejemplos se da un ApiKey no válida)

Vamos a dividir la información de los usuarios entre pública y privada. La pública hace referencia a toda esa información que puede accederse de forma pública en Todoexpertos.com (perfil de usuario, preguntas de usuarios, etc.), mientras que la privada hace referencia a la información que encontraríamos en MiTodoexpertos. Tal y como se informará más adelante, la información privada requiere consentimiento por parte del usuario.

Editar

Información pública

Editar

/username/userprofile

  • Descripción: Perfil del usuario.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/userprofile?apikey=1234
    • username: nombre del usuario del que quiere obtenerse el profile.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:te="http://www.todoexpertos.com/api/te">
  <channel>
    <title>GetUserProfile</title>
    <description>Nos da el perfil del usuario</description>
    <link>http://api.todoexpertos.com/username/userprofile</link>
    <item>
      <title>Nombre del usuario</title>
      <te:isexpert>1 o 0 según si es o no experto</te:isexpert>
      <te:registereddate>Fecha en que se registro</te:registereddate>
      <te:finishedquestions>Cantidad de preguntas que ha finalizado</te:finishedquestions>
    </item>
  </channel>
</rss>

Editar

/username/questions

  • Descripción: Preguntas públicas generales de un usuario.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/questions?apikey=1234
    • username: nombre del usuario del que se quiere obtener las preguntas.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
  <channel>
    <title>Preguntas del usuario</title>
    <description>Preguntas en TodoExpertos.com</description>
    <link>http://www.todoexpertos.com/</link>
    <item>
      <title>Ejemplo de título de la pregunta</title>
      <description>Ejemplo de texto de la pregunta</description>
      <link>Url de la pregunta</link>
    </item>
    ...
  </channel>
</rss>

Editar

/username/questions/categorypath

  • Descripción: Preguntas públicas de un usuario en una categoría.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/questions/categorypath?apikey=1234
    • username: nombre del usuario del que se quiere obtener las preguntas en la categoría.
    • categorypath: path de la categoría a la que pertenece el usuario.
  • Ejemplo de respuesta: el RSS devuelto es el mismo que para el caso anterior.



Editar

Información privada

Podemos acceder a la información privada del usuario. Para ello debemos disponer de su nombre y contraseña. El caso más típico del uso de la información privada del usuario es la que hará el propio desarrollador. Por ejemplo, para listar las preguntas que ha hecho y le han finalizado, o que ha hecho y siguen activas.

Para acceder a la información privada, además de la ApiKey hay que añadir un nuevo parámetro al QueryString: el AuthCode.

A continuación listamos y describimos las llamadas REST para acceder a la información privada del usuario, comenzando por cómo obtener el AuthCode a partir del nombre de usuario y contraseña. (NOTA: En los ejemplos se da un ApiKey y un AuthCode no válidos).

Editar

/Auth

  • Descripción: Devuelve el AuthCode a partir del nombre de usuario y contraseña.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/Auth?user=username&pwd=userpassword&apikey=1234
    • username: nombre del usuario del que quiere obtenerse el AuthCode.
    • userpassword: contraseña del usuario del que quiere obtenerse el AuthCode.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:te="http://www.todoexpertos.com/api/te">
  <channel>
    <title>GetAuthCode</title>
    <description>Devuelve el AuthCode de un usuario</description>
    <link>http://api.todoexpertos.com/Auth?user=username&amp;pwd=password</link>
    <item>
      <title>Nombre del usuario</title>
      <te:authcode>AuthCode del usuario</te:authcode>
    </item>
  </channel>
</rss>

Editar

/username/favorite/experts

  • Descripción: Devuelve un listado de los expertos favoritos del usuario.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/favorite/experts?apikey=1234&AuthCode=abcd
    • username: nombre del usuario del que quiere obtenerse su listado de expertos favoritos.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:te="http://www.todoexpertos.com/api/te">
  <channel>
    <title>GetFavoriteExperts</title>
    <description>Devuelve los expetos favoritos del usuario</description>
    <link>http://api.todoexpertos.com/username/favorite/experts</link>
    <item>
      <title>Nombre del experto</title>
      <te:categorypath>Path local de la categoría de la que es experto</te:categorypath>
      <te:categoryurl>Url Completa de la categoría de la que es experto</te:categoryurl>
    </item>
    ...
  </channel>
</rss>

Editar

/username/favorite/categories

  • Descripción: Devuelve un listado de las categorías favoritas del usuario.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/favorite/categories?apikey=1234&AuthCode=abcd
    • username: nombre del usuario del que quiere obtenerse su listado de categorías favoritas.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:te="http://www.todoexpertos.com/api/te">
  <channel>
    <title>GetFavoriteCategories</title>
    <description>Devuelve las categorías favoritas del usuario</description>
    <link>http://api.todoexpertos.com/username/favorite/categories</link>
    <item>
      <title>Nombre de la categoría</title>
      <te:categorypath>Path local de la categoría</te:categorypath>
      <te:categoryurl>Url Completa de la categoría</te:categoryurl>
    </item>
    ...
  </channel>
</rss>

Editar

/username/questions/method

  • Descripción: Devuelve un listado de las preguntas hechas según el método que se le pase. Por ejemplo si quisiéramos ver las preguntas finalizadas pondríamos "finished", si quisiéramos las preguntas nuevas pondríamos "active", etc.
  • Ejemplo de llamada: http://api.todoexpertos.com/v1/username/questions/method?apikey=1234&AuthCode=abcd
    • username: nombre del usuario del que quiere obtenerse su listado de preguntas.
    • method: método que queremos obtener. A continuación un listado descriptivo de todos los métodos:
      • new: preguntas con respuestas nuevas que aún no has respondido/finalizado.
      • activas: preguntas activas.
      • finished: preguntas finalizadas.
      • discarted: preguntas descartadas.
      • board: preguntas públicas que aún no te han contestado.
  • Ejemplo de respuesta:
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
  <channel>
    <title>Preguntas finalizadas de experto</title>
    <description>Preguntas finalizadas de experto</description>
    <link>http://www.todoexpertos.com/mitodoexpertos/expert/questions/finished</link>
    <item>
      <title>Título de la pregunta</title>
      <description>Texto de la pregunta</description>
      <link>Enlace de la pregunta</link>
    </item>
    ...
  </channel>
</rss>