Documentación - Contenedor 'chefsocial'

¿Buscas la Documentación API v1?

Introducción

El contenedor chefsocial permite registrar un chef a partir de sus datos sociales.
Se debe de usar este servicio una vez que se envió la información del chef al servicio login y que regresó el estatus 2, 3, o 4 (ya que el estatus 1 es reservado para usuarios nativos con usuario/password).
Se usará el recurso POST o GET según la pantalla que usa el chef para enlazarse:
Si es un "chef ya conocido" (sea por login/password o porque ya conocemos el correo de la red social), tendrá que enviar un POST (modify).
Si es totalmente nuevo (login/correo no conocido) entonces tendrá que enviar un PUT (insert).

Recurso PUT: registro social

Este recurso permite dar de alta un chef social, a través de la típica pantalla (casi identica al chef nativo, pero enlazado con el chef social):
Nombre:
Apellido:
Correo:
Recibir newsletter ?
Aceptar las políticas:

La diferencia con el servicio "nativo" normal, es que el usuario:
1. no tendrá que validar un código para loggearse (ya que conocemos sus datos de red social, esta ya hizo el trabajo de validar).
2. No hay contraseña. Es la red social que controla el login.
3. hay que enviar el GUID dado por gigya para poder hacer el enlace físico.
Los parámetros a enviar al PUT son los siguientes:
GUID = el gigya unique ID enviado en respuesta del servicio 'login' con objeto gigya.
usuario = el correo del nuevo chef. Será validado por el servidor. Es el correo nuevo que no debe de existir en kiwilimon.
nombre = el nombre del nuevo chef. Obligatorio.
apellido = el appellido del nuevo chef. Obligatorio.
newsletter = si desea o no recibir el newsletter: 0 = no, 1 = si
politicas = aceptar las políticas, tiene que ser 1
formato: Es el formato en el cual queremos los resultados. Es uno de 'json', 'xml' o 'txt. Es un parámetro opcional, y si no esta especificado regresa un JSON por defecto.
Si todo funciona bien, el servicio regresa los datos de login (tokens):
{
  "token":"B9sl6n7wH537bH87aWwItP96",
  "UID":100468,
  "sessionToken":"AT3_29E127758D556775CCA94EA72CB2C489_lIHnKM4CfbFmmnWHn2eTmeUNBm9GygoBvyJ2PWqkK9yQ6sMGqqZ6ElkMXwkbJXiub84VQB8PU-Du93DJm4T_Hagvky3el8AUfVdEl1t_8O7zOLOKeuCCxWZ5jW4KMw4UUJz_lgy-7IouxMjy3VfnPg==",
  "sessionSecret":"BZzfZXOIGHUQvqGxb2SWng=="
}
En caso de error, el servicio regresa el siguiente formato:
{"estatus":"Error","tipo":"usuario","message":"Correo con error.","codigo":3}
estatus = Error, invariable.
tipo = el nombre del campo en el cual ocurre el error.
message = el mensaje del error.
codigo = el tipo de error si el campo es 'usuario' (el correo).

Los valores son:
error = usuario, contrasena, contrasena2, nombre, apellido, politicas
codigo = 1: este correo ya existe en la base de datos de kiwilimon
codigo = 2: el dominio del correo correo no existe o no tiene servidor de correos
codigo = 3: el correo esta vacio o no es un correo bien formateado

Recurso POST: enlace social

Este recurso permite de enlazar la red social a un chef ya existente, solicitando los datos básicos de login:
Correo:
Contraseña: (solo para cambiarla)

Los parámetros a enviar al POST son los siguientes:
GUID = el gigya unique ID enviado por el servicio 'login'.
usuario = el correo del nuevo chef. Será validado por el servidor.
contrasena = la contraseña del chef para conectarse
formato: Es el formato en el cual queremos los resultados. Es uno de 'json', 'xml' o 'txt. Es un parámetro opcional, y si no esta especificado regresa un JSON por defecto.
Si todo funciona bien, el servicio regresa:
{
  "token":"B9sl6n7wH537bH87aWwItP96",
  "UID":100468,
  "sessionToken":"AT3_29E127758D556775CCA94EA72CB2C489_lIHnKM4CfbFmmnWHn2eTmeUNBm9GygoBvyJ2PWqkK9yQ6sMGqqZ6ElkMXwkbJXiub84VQB8PU-Du93DJm4T_Hagvky3el8AUfVdEl1t_8O7zOLOKeuCCxWZ5jW4KMw4UUJz_lgy-7IouxMjy3VfnPg==",
  "sessionSecret":"BZzfZXOIGHUQvqGxb2SWng=="
}
En caso de error, el servicio regresa el siguiente formato:
{"estatus":"Error","message":"Usuario no válido"}
estatus = Error, invariable.
message = el mensaje del error.