API-v2.1.0

URI: /auth 

Versión: 2.0 

Estructura URL: http://api.v2.betalocales.com/v2/auth 

Método HTTP: POST /auth/login (ORIGIN_WEB) 

Descripción: Realiza el login con un usuario. 

Notas: Cada vez que se realiza el login, se genera un token nuevo para el usuario. 

URL ejemplo: http://api.v2.betalocales.com/v2/auth/login 

Request: 

POST /v2/auth/login HTTP/1.1 

Host: api.v2.betalocales.com 

ControlCapIsApp: forcetrue 

CacheControl: nocache 

ContentType: application/xwwwformurlencoded 

Parámetros: 

Nombre Descripción Requerido Tipo Valor 

grant_type Tipo de acceso Sí String Password 

origin Tipo de origen Sí String ORIGIN_WEB 

client_id Identificador del cliente Sí String 

client_secret Llave privada Si String 

scope Scope Sí String subscriber 

username Usuario Sí String 

password Contrseña Sí String 

Response: 

HTTP/1.1 200 OK 

ContentType: application/json; charset=utf8 

{ 

"first_name": "Judit", 

"surname": "Ipad TLF", 

"email": "judit.borderia@tuslocalesfavoritos.com", 

"email_verified": 1, 

"profile_completed": 1, 

"token": { 

"access_token": "kz7O8meqtkehydQ6V98No8KHjZKl1sriQs1e9zK5", 

"token_type": "Bearer", 

"expires_in": 3600, 

"refresh_token": "CJFvGoYdM1tZEXebltW2UkJVirnhWEgQXTpILusm" 

} 

}

Descripción de la respuesta: 

Nombre Descripción Tipo 

first_name Nombre del usuario String 

surname Apellidos del usuario String 

email Email del usuario String 

email_verified Indica si el email está verificado. Boolean 

profile_completed Indica si el perfil del usuario está completo Boolean 

token Nodo con la información de acceso Object 

Descripción del nodo token: 


access_token Token de acceso String 

token_type Tipo de token String 

expires_in Tiempo de expiración del token de acceso en segundos String 

refresh_token Token de refresco String 

Posibles HTTP Status: 

HTTP Status 

Descripción 

200 OK OK 

400 Bad Request Petición incorrecta 

401 Unauthorized Credenciales incorrectas

Método HTTP: POST /auth/login (ORIGIN_FACEBOOK) 

Descripción: Realiza el login con facebook. 

Notas: Cada vez que se realiza el login, se genera un token nuevo para el usuario. 


Request: 






Parámetros: 


grant_type Tipo de acceso Sí String Password 

origin Tipo de origen Sí String ORIGIN_FACEBOOK 




access_token Token de acceso de Facebook Sí String 

Response: 

HTTP/1.1 200 OK 


{ 






"token": { 





} 

} 









Descripción del nodo token:







HTTP Status 

Descripción 

200 OK OK 



Método HTTP: POST /auth/logout 

Descripción: Realiza el logout de un usuario. 

Notas: Cuando se realiza el logout de un usuario el token queda revocado, deberá hacerse login para obtener un nuevo 

token válido. 

URL ejemplo: http://api.v2.betalocales.com/v2/auth/logout 

Request: 

POST /v2/auth/logout HTTP/1.1 



Authorization: Bearer qDMSCgwsNNF3EDbQzAUJz4TsD7GW9Cu2Jd8ki8aU 



Parámetros: Sin parámetros. 

Response: 

HTTP/1.1 200 OK 



HTTP Status 

200 OK OK 

Descripción 

401 Unauthorized No autorizado a hacer logout con el token suministrado

Método HTTP: POST /auth/signup (ORIGIN_FACEBOOK) 

Descripción: Realiza el registro de un usuario nuevo a través de facebook 

Notas: Tras el registro, se envía al usuario un email de bienvenida. Se puede acceder a la aplicación desde el momento 

en que se completa el registro. 

URL ejemplo: http://api.v2.betalocales.com/v2/auth/signup 

Request: 

POST /v2/auth/signup HTTP/1.1 





Parámetros: 


origin Tipo de origen Sí String ORIGIN_FACEBOOK 




access_token Token de acceso facilitado por Facebook Sí String 

Response: 

HTTP/1.1 200 OK 


{ 






"token": { 





} 

} 
















HTTP Status 

Descripción 

200 OK OK 

400 Bad Request Parámetros incorrectos. 

409 Conflict El email ya está en uso. 

500 Internal Server Error Error interno.

Método HTTP: POST /auth/login (REFRESH TOKEN) 

Descripción: Refresca el token de acceso a partir del token de refresco facilitado en el login. 

Notas: Se generarán un token de acceso y de refresco nuevos. 


Request: 






Parámetros: 


grant_type Tipo de acceso Sí String refresh_token 



refresh_token Token de refresco Sí String 

Response: 

HTTP/1.1 200 OK 


{ 






"token": { 





} 

} 
















HTTP Status 

Descripción 

200 OK OK 



Método HTTP: POST /auth/devicetoken 

Descripción: Actualiza el “device token” de un usuario. 

Notas: Se pueden actualizar los datos de plataforma, modelo y versión del teléfono. 

URL ejemplo: http://api.v2.betalocales.com/v2/auth/devicetoken 

Request: 

POST /v2/auth/devicetoken HTTP/1.1 






Parámetros: 


device_token Device token Sí String 

platform Plataforma / sistema operativo No String 

model Modelo del teléfono No String 

version Versión del sistema operativo No String 

maker Fabricante No String 

Response 

HTTP/1.1 200 OK 


Posibles Status HTTP: 

Http Status 

Descripción 

200 OK OK. 

400 Bad Request Petición incorrecta. 

401 Unauthorized No autorizado. 


URI: /profile 

Versión: 2.0 

Estructura URL: http://api.v2betalocales.com/v2/profile 

Método HTTP: GET /profile 

Descripción: Recupera la información del perfil de un usuario. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/profile 

Request: 

POST /v2/profile HTTP/1.1 






Response 

HTTP/1.1 200 OK 


{ 



"genre": "W", 

"birthdate": "19831009", 


"postal_code": "28003", 

"mobile_prefix": "34", 

"mobile_number": "664326445", 

"not_interested_in": { 

"soccer": 1, 

"kids": 1, 

"singles": 1, 

"smokers": 1 

} 

} 





genre Sexo (M – hombre, W mujer) Char 

birthdate Fecha de nacimiento String 

postal_code Código postal Boolean 

mobile_prefix Prefijo país del teléfono móvil String 

mobile_number Número de teléfono móvil String 

not_interested_in Temas en los que el usuario no está interesado Array 

Atributos del Array not_interested_in


soccer Fútbol (1 No está interesado, 0 – Está interesado) Boolean 

kids Infantil (1 No está interesado, 0 – Está interesado) Boolean 

singles Singles (1 No está interesado, 0 – Está interesado) Boolean 

smokers Fumadores (1 No está interesado, 0 – Está interesado) Boolean 


HTTP Status 

Descripción 

200 OK OK. 



Método HTTP: PUT /profile 

Descripción: Actualiza la información del perfil de un usuario. 

Notas: 


Request: 

PUT /v2/profile HTTP/1.1 






Parámetros: 


first_name Nombre del usuario Sí String 

surname Contraseña No String 

genre Género (M – hombre, W mujer) Sí String 

birthdate Fecha de nacimiento Sí String 

postal_code Código postal No String 

mobile_prefix Prefijo país del teléfono móvil No String 

mobile_number Número de teléfono móvil No String 

not_interested_in Temas en los que el usuario no está interesado Sí Array 

Parámetros del Array not_interested_in 


soccer Fútbol (1 No está interesado, 0 – Está interesado) Sí Boolean 

kids Infantil (1 No está interesado, 0 – Está interesado) Sí Boolean 

singles Singles (1 No está interesado, 0 – Está interesado) Sí Boolean 

smokers Fumadores (1 No está interesado, 0 – Está interesado) Sí Boolean 

Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK. 




Método HTTP: PATCH /profile 

Descripción: Actualiza la contraseña del usuario. 

Notas: 


Request: 

PATCH /v2/profile HTTP/1.1 






Parámetros: 


attribute Nombre del atributo Sí String password 

value Valor del atributo (nueva contraseña) Sí String 

Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK. 




Método HTTP: GET /profile/reasons 

Descripción: Permite recuperar un listado con los motivos para cuando un usuario quiere darse de baja de la 

plataforma. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/profile/reasons 

Request: 

GET /v2/profile HTTP/1.1 





Parámetros: Sin parámetros 

Response 

HTTP/1.1 200 OK 


[ 

{ 

"id": 1, 

"name": "No uso la aplicación" 

}, 

{ 

"id": 2, 

"name": "La aplicación no me resulta interesante" 

}, 

{ 

"id": 3, 

"name": "No encuentro mis locales favoritos" 

}, 

{ 

"id": 4, 

"name": "Los locales me mandan demasiada información" 

} 

] 

Atributos del Array data 


id Identificador del motivo (se usará como parámetro al darse de baja) Int 

text Texto del motivo. String 


HTTP Status Descripción 

200 OK 

401 Unauthorized 

500 Internal Server Error

Método HTTP: DELETE /profile (/profile) 

Descripción: Permite dar de baja a un usuario de la plataforma 

Notas: El listado de motivos de baja puede ser recuperado de GET /profile/reasons 


Request: 

DELETE /v2/profile HTTP/1.1 





Parámetros: 


reason_id Identificador del motivo por el que se da de baja. Sí Int 

Response 

HTTP/1.1 200 OK 




204 OK 

400 Bad Request 

401 Unauthorized 


URI: /diary 

Versión: 2.0 

Estructura URL: http://api.v2.betalocales.com/v2/diary 

Método HTTP: GET /diary 

Descripción: Recupera un listado de locales que estén en la agenda del usuario. 

Notas: Por defecto el número de registros por página se establece en 10. 

URL ejemplo: http://api.v2.betalocales.com/v2/diary?filters[page]=1 

Request: 

GET /v2/diary HTTP/1.1 





Parámetros: 


filters[] Filtros del listado No Array 

Atributos del Array filters[] 


page Número de página No Int 

limit Número de registros por página No Int 

latitude Posición del usuario No Decimal 

longitude Posición del usuario No Decimal

Response: 

HTTP/1.1 200 OK 


{ 

"pagination": { 

"current_page": 1, 

"total_pages": 1, 

"total_items": 1 

}, 

"items": [ 

{ 

"id": 297, 

"name": "Tome Vinos", 

"street_type": "Calle", 

"city": "Madrid", 

"address": "General Rodrigo, 2", 

"latitude": 40.443, 

"longitude": 3.71404, 

"distance": "A 137 m de ti", 

"thumbnail": 

"http://media.betalocales.com/place/2/9/7/pictures/front/297_841114333599fcf36bbf72f0174e14c8_20151022.jpg", 

"favorite": 0, 

"diary": 1, 

"share": { 

"url": "http://web.betalocales.com/locales/tomevinos", 

"subject": "Añade Tome Vinos a tuslocalesfavoritos.com, el único sitio donde tú eliges quién te envía información." 

} 

} 

] 

} 

Atributos del objeto pagination 


current_page Página actual Int 

total_pages Páginas totales int 

Atributos del Array items 


id Identificador del local Int 

name Nombre del local String 

street_type Tipo de calle String 

address Dirección del local String 

city Ciudad String 

thumbnail Url al thumbnail del local String 

favorite Indica si el local está en favoritos Boolean 

diary Indica si el local está en la agenda Boolean

Atributos del Array share 


url Url al local String 

subject Texto para el asunto del email String 


HTTP Status 

Descripción 

200 OK OK. 

401Unauthorized 

No autorizado. 


Método HTTP: POST /diary/:place_id 

Descripción: Añade un local a la agenda del usuario. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/34 

Request: 

POST /v2/diary/34 HTTP/1.1 







Response: 

HTTP/1.1 201 Created 


Posibles Status http: 

http Status 

Descripción 

201 Created OK. 

400 Bad Request No se ha recibido el identificador del local. 


404 Not Found No se ha encontrado el local. 

409 Conflict El local ya está en la agenda o es favorito. 

500Internal Server Error 

Error interno.

Método HTTP: DELETE /diary/:place_id 

Descripción: Elimina un local de la agenda del usuario 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/34 

Request: 

DELETE /v2/diary/34 HTTP/1.1 







Response: 

HTTP/1.1 204 No content 


Posibles Status http: 

http Status 

Descripción 

204 No Content OK. 

400 Bad Request No se ha recibido el identificador del local. 


404 Not Found No se ha encontrado el local. 

412 Precondition Failed El local no está en la agenda. 


URI: /diary/favorites 

Versión: 2.0 

Estructura URL: http://api.v2.betalocales.com/v2/diary/favorites 

Método HTTP: GET /diary/favorites 

Descripción: Recupera un listado de locales favoritos del usuario. 

Notas: Por defecto el número de registros por página se establece en 10. 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/favorites?filters[page]=1 

Request: 

GET /v2/diary/favorites HTTP/1.1 





Parámetros: 






limit Número de registros por página No Int 

latitude Posición del usuario No Decimal 

longitude Posición del usuario No Decimal

Response: 

HTTP/1.1 200 OK 


{ 

"pagination": { 

"current_page": 1, 

"total_pages": 1, 

"total_items": 1 

}, 

"items": [ 

{ 

"id": 297, 

"name": "Tome Vinos", 

"street_type": "Calle", 

"city": "Madrid", 

"address": "General Rodrigo, 2", 

"latitude": 40.443, 

"longitude": 3.71404, 

"distance": "A 137 m de ti", 

"thumbnail": 

"http://media.betalocales.com/place/2/9/7/pictures/front/297_841114333599fcf36bbf72f0174e14c8_20151022.jpg", 

"favorite": 1, 

"diary": 0, 

"notifications": { 

"total": 0, 

"unread": 0 

}, 

"share": { 

"url": "http://web.betalocales.com/locales/tomevinos", 

"subject": "Añade Tome Vinos a tuslocalesfavoritos.com, el único sitio donde tú eliges quién te envía información." 

} 

} 

] 

} 





Atributos del Array items 





address Dirección del local String 



favorite Indica si el local está en favoritos Boolean 

diary Indica si el local está en la agenda Boolean

Atributos del Array notifications 


total Total notificaciones Int 

unread Total notificaciones sin leer Int 






HTTP Status 

Descripción 

200 OK OK. 

401Unauthorized 

No autorizado. 


Método HTTP: POST /diary/favorites/:place_id 

Descripción: Añade un local a los favoritos del usuario o actualiza las preferencias del usuario para un local que ya 

está en favoritos. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/favorites/34 

Request: 

POST /v2/diary/favorites/34 HTTP/1.1 






Parámetros: 

Nombre Descripción Requerido Tipo 

come_when[] Array de ids de la opciones “¿Cuándo vienes?” Sí Array 

frecuency[] Array de ids de la opciones “¿Con qué frecuencia vienes?” Sí Array 

choose_us_for[] Array de ids de la opciones “Me eliges por…” Sí Array 

drinking[] Array de ids de la opciones “¿Qué bebes?” Sí Array 

come_usually[] Array de ids de la opciones “Sueles venir…” Sí Array 

come_with[] Array de ids de la opciones “Vienes con…” Sí Array 

Response: 

HTTP/1.1 200 OK 



Http Status 

Descripción 

200 OK OK 


401 Unauthorized No autorizado 

404 Not Found No se ha encontrado el local 

409 Conflict El local ya está en los favoritos. 

500 Internal Server Error Error interno

Método HTTP: DELETE /diary/favorites/:place_id 

Descripción: Elimina un local de los favoritos del usuario 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/favorites/34 

Request: 

DELETE /v2/diary/favorites/34 HTTP/1.1 






Parámetros: 


reason_id Motivo por el que se da de baja. No Int 

Response: 

HTTP/1.1 200 OK 



Htpp Status 

Descripción 

200 OK OK 




412 Precondition Failed El local no está en los favoritos 


URI: /public 

Versión: 2.0 

Estructura URL: http://api.v2.betalocales.com/v2/public 

Método HTTP: GET /public/places 

Descripción: Recupera un listado de locales. 

Notas: Por defecto el número de registros por página se establece en 10. Todos los filtros pueden aplicarse de manera 

simultánea. 

Si la petición no está autenticada, los nodos “notificactions”, “diary”, “favorite”, “subscribed” no estarán en la respuesta. 

Si no se aplican los filtros “latitude” y “longitude”, el campo “distance” en la respuesta estará vacío. 

URL ejemplo: http://api.v2.betalocales.com/v2/public/places?filters[page]=1&filters[by_city]=Madrid 

Request: 

GET /v2/public/places HTTP/1.1 





Parámetros: 





by_name Filtrar listado por el nombre de local. No String 

by_street Filtrar listado por el nombre de la calle. No String 

by_city Filtrar listado por el nombre de la ciudad. No String 

city_id Identificador de la ciudad No Int 

latitude Latitud geográfica del usuario No Decimal 

longitude Longitud geográfica del usuario No Decimal 


limit Número de registros por página No Int

Response: 

HTTP/1.1 200 OK 


{ 

pagination: 

{ 

current_page: 1, 

total_pages: 1, 

total_items: 1 

} 

}, 

items: 

[{ 

}, {…}] 

id: "34", 

name: "La Claqueta", 

street_type: "calle", 

city: "Madrid", 

address: "Guzman el Bueno 133, 6º, 28003", 

latitude: "40.44327", 

longitude: "3.71259", 

distance: "A 41m de ti", 

thumbnail: "http://media.betalocales.com/place/3/4/pictures/front/34_eb7e231d873df56d95eb61e10dda 

0c36_20151022.jpg", 

notifications: 

{ 

total: 3 

unread: 0 

}, 

diary: 1, 

favorite: 0, 

subscribed: 1, 

share: 

{ 

url: "http://web.betalocales.com/locales/laclaqueta", 

subject: “Añade La Claqueta a tuslocalesfavoritos.com, el único sitio donde tú eliges quién te 

envía información. “ 

} 





Atributos de los objetos del Array items




description Descripción del local String 


address Dirección del local con código postal String 

latitude Latitud geográfica del local Decimal 

longitude Longitud geográfica del local Decimal 

distance 

Distancia expresada en metros entre la posición geográfica del local y 

el usuario 

Int 


state Provincia String 


diary Indica si el local está en la agenda del usuario Boolean 

favorite Indica si el local está en los favoritos del usuario Boolean 

subscribed Indica si el usuario permite recibir comunicaciones del local Boolean 

Atributos del Array notifications 


total Total notificaciones Int 

unread Total notificaciones sin leer Int 







200 OK 


Método HTTP: GET /public/places/short 

Descripción: Recupera un listado de duplas (id, nombre) de locales. 

Notas: Para realizar la búsqueda, los filtros deben tener al menos una longitud mínima de 3 caracteres. 

URL ejemplo: http://api.v2.betalocales.com/v2/public/places/short?filters[by_city]=Madrid 

Request: 

GET /v2/public/places/short HTTP/1.1 




Parámetros: 





by_name Filtrar listado por el nombre de local. No String 

by_street Filtrar listado por el nombre de la calle. No String 

by_city Filtrar listado por el nombre de la ciudad. No String 

Response: 

HTTP/1.1 200 OK 


[ 

{ 

"id": 318, 

"name": "14 Rosas" 

}, 

{ 

"id": 65, 

"name": "1862 Dry Bar" 

}, 

{ 

"id": 1111, 

"name": "1903 Sport Bar & Lounge Restaurant" 

}, 

{..} 

] 

Atributos de los objetos del Array 



name Nombre del local String


HTTP Status 

Descripción 

200 OK OK 


Método HTTP: GET /public/places/:place_id 

Descripción: Recupera los datos de un local. 

Notas: Si la petición no está autenticada, los nodos “notificactions”, “diary” y “favorite” no estarán en la respuesta. 

URL ejemplo: http://api.v2.betalocales.com/v2/public/places/34 

Request: 

GET /v2/public/places/34 HTTP/1.1 





Response: 

HTTP/1.1 200 OK 


{ 

id: "34", 

name: "La Claqueta", 

food_type: "Friends&Drinks", 

address: "Calle Guzmán el Bueno 135, 28003, Madrid, Madrid", 

description: "Divertido local para charlar a cualquier hora, 

donde encontrarás una 

completa carta de cócteles (piña colada, Bloody Mary,… ", 

web_site: "http://www.tuslocalesfavoritos.com ", 

timetable: "Lunes a domingos: 11:00 02:00", 

phone: "915435656", 

email: "info@tuslocalesfavoritos.com", 

facebook: "", 

latitude: "0", 

longitude: "0" 

services: 

[ 

"wifi","idiomas","eventos","brunch", 

"abierto domingos","menú del día" 

], 

ideal_for: 

[ 

"eventos","negocios","celebraciones","grupos" 

], 

images: 

[ 

"http://media.betalocales.com/place/3/4/pictures/front/34_eb7e231d873df56d95eb61e10dda0c36_2015 

1022.jpg", 

"http://media.betalocales.com/place/3/4/pictures/front/34_eb7e231d873df56d95eb61e10dda0c36_2015 

1023.jpg" 

], 

notifications: 

{ 

total: 3, 

unread: 0 

}, 

diary: 1, 

favorite: 0, 

share: 

{ 

url: "http://web.betalocales.com/locales/laclaqueta", 

subject: "Añade La Claqueta a tuslocalesfavoritos.com, el único sitio donde tú eliges quién te envía 

información. ", 

} 

}




name Nombre String 

food_type Tipo de comida String 


address Dirección String 

cp Código postal String 


state Provincia String 

description Descripción del local String 

website Url del sitio web del local String 

timetable Horario String 

phone Teléfono String 

email Email de contacto String 

facebook URL de la página de Facebook String 

latitude Latitud geográfica del local String 

longitude Longitud geográfica del local String 

services Array de servicios que ofrece el local Array 

ideal_for Array de característica de “Ideal para” Array 

images Array de imágenes del local Array 



200 OK OK 

404 Not Found El local no existe

Método HTTP: GET /diary/favorites/:place_id/subscription 

Descripción: Suscribe al usuario a las comunicaciones de un local. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/favorites/34/subscription 

Request: 

GET /v2/diary/favorites/34/subscription HTTP/1.1 






Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK 





Método HTTP: GET /diary/favorites/:place_id/unsubscription 

Descripción: Elimina la suscripción del usuario a las comunicaciones de un local. 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/diary/favorites/34/unsubscription 

Request: 

GET /v2/diary/favorites/34/unsubscription HTTP/1.1 






Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK 





URI: /notifications 

Versión: 2.0 

Estructura URL: http://api.v2.betalocales.com/v2/notifications 

Método HTTP: GET /notifications 

Descripción: Recupera un listado de notificaciones del usuario. 

Notas: Por defecto el número de registros por página se establece en 20. Todos los filtros pueden aplicarse de manera 

simultánea. 

URL ejemplo: http://api.v2.betalocales.com/v2/notifications?filters[page]=1 

Request: 

GET /v2/notifications HTTP/1.1 





Parámetros: 


filters[] Filtros del listado No Array 



place_id Filtrar listado por un local en concreto. No Int 

title Filtrar listado por el título de la notificación. No String 

category 

Filtrar listado por categoría 

(“news”,”menu”,”welcomepack”). 

No String 

type Filtrar por tipo (‘info’, ‘coupon’) No String 


limit Número de registros por página No Int

Response: 

HTTP/1.1 200 OK 


{ 

} 

pagination: 

{ 

current_page: 1, 

total_pages: 1, 

total_items: 1 

}, 

items: 

[{ 

id: "198", 

category: "welcomepack", 

type: "coupon", 

place_id: "34", 

place_name: "La Claqueta", 

readed: 0, 

title: "WELCOMEPACK EJEMPLO", 

date: "20150723 14:14:04", 

url: "http://web.betalocales.com/message/198/399", 

coupon_data: 

{ 

signature: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhcGkuYmV0YWxvY2FsZ 

XMuY29tIiwiYXVkIjoidGxmLWFwcCIsImlhdCI6MTQzNzY1MzY0NCwiZXhwIjoxNDM3OTQ4M 

DAwLCJuYmYiOjE0Mzc0Mjk2MDAsImp0aSI6ImE0MzhhOTVmYTQyMDk3Njk5NDA3YTdkY 

Tk5YzFhMDEwIiwidWlkIjoiMjYiLCJjaWQiOiIxNyJ9.qFiSLz3zrumpha0LWOoGNEqKy 

_QhXqkHjiKOL_uXvQ", 

status: "1", 

valid_from: "20150721 00:00:00", 

valid_to: "20150727 00:00:00", 

redeem_date: "20150723 14:14:59" 

} 

}, 

{...}] 




total_pages Páginas totales int

Atributos de los objetos del Array items 


id Identificador de la notificación Int 

category Categoría de la notificación (“news”,”menu”,”welcomepack”). String 

type Tipo de notificación (“info”, “coupon”) String 

place_id Identificador del local int 

place_name Nombre del local String 

readed Indica si la notificación se ha leído (1 – Sí, 0 – No) Boolean 

title Título de la notificación String 

url URL de la notificación String 

date Fecha de la notificación. Formato “Ymd H:i:s“ String 

Atributos de los objetos del Array items 


signature Firma del cupón Int 

status 

Estado del cupón. Valores que puede tomar: 

0 – Pendiente de canjear 

1 – Canjeado 

1 Caducado 

Int 

valid_from Fecha desde la que es válido el cupón. Datetime 

valid_to Fecha hasta la que es válido el cupón. int 

redeem_date Fecha en la que se ha canjeado el cupón String 



200 OK 

401 Unauthorized

Método HTTP: GET /notifications/count 

Descripción: Recupera las notificaciones indicando el total y las no leídas por categoría y tipo . 

Notas: 

URL ejemplo: http://api.v2.betalocales.com/v2/notifications/count 

Request: 

GET /v2/notifications/count HTTP/1.1 





Response 

HTTP/1.1 200 OK 


[ 

{ 

"name": "Menús", 

"category": "menu", 

"info": { 

"total": 0, 

"unread": 0 

}, 

"coupon": { 

"total": 0, 

"unread": 0 

} 

}, 

{ 

"name": "Bienvenidas", 

"category": "welcomepack", 

"info": { 

"total": 0, 

"unread": 0 

}, 

"coupon": { 

"total": 0, 

"unread": 0 

} 

}, 

{ 

"name": "Eventos y noticias", 

"category": "news", 

"info": { 

"total": 4, 

"unread": 1 

}, 

"coupon": { 

"total": 4, 

"unread": 0 

} 

} 

]

Descripción de los nodos de la respuesta: 


name Nombre de la categoría String 

category Identificador de la categoría String 

total Indica el total de notificaciones del tipo. Int 

unread Indica el total de notificaciones sin leer del tipo. Int 


HTTP Status 

Descripción 

200 OK OK 

401 Unauthorized No autorizado

Método HTTP: GET /notifications/:notification_id 

Descripción: Recupera la url de una notificación. 

Notas: La notificación se marcará como leída al realizar la petición. 

URL ejemplo: http://api.v2.betalocales.com/v2/notifications/149 

Request: 

GET /v2/notifications/149 HTTP/1.1 






Response 

HTTP/1.1 200 OK 


{ 

"id": 56, 

"url": "http://web.betalocales.com/message/190/399" 

} 



notification_id Identificador de la notificación Int 

url URL a la notificación String 


HTTP Status 

Descripción 

200 OK OK 



403 Forbidden Sin permisos para acceder a la notificación 


Método HTTP: DELETE /notifications/:notification_id 

Descripción: Permite borrar una notificación. 

Notas: 


Request: 

DELETE /v2/notifications/149 HTTP/1.1 






Response 

HTTP/1.1 204 OK 


Catálogo de errores: 

Id Descripción Status 

ERROR_DELETE_NOTIFICATION_0001 No se ha recibido el identificador de la notificación. 400 

ERROR_DELETE_NOTIFICATION_0002 No tiene permiso para borrar la notificación. 403 

ERROR_DELETE_NOTIFICATION_0003 No se ha podido borrar la notificación. 500 


HTTP Status 

Descripción 

204 No Content OK 



403 Forbidden Sin permiso para borrar la notificación 


Método HTTP: PATCH /notifications/:notification_id 

Descripción: Marcar una notificación como leída. 

Notas: 


Request: 

PATCH /v2/notifications/149/readed HTTP/1.1 






Parámetros: 


attribute Nombre del atributo Sí String status_id 

value Valor del atributo Sí String 12 

Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK 



403 Forbidden Sin permiso sobre la notificación 


Método HTTP: POST public/track/coupon 

Descripción: Marca un cupón como canjeado. 

Notas: Debe incluirse la firma del cupón en el payload como parámetro “signature”. 

URL ejemplo: http://api.v2.betalocales.com/v2/public/track/coupon 

Request: 

POST /v2/public/track/coupon HTTP/1.1 





Parámetros: 


signature Firma del cupón Sí String 

Response 

HTTP/1.1 200 OK 



HTTP Status 

Descripción 

200 OK OK. 

409 Conflict Cupón ya canjeado, expirado o revocado. 

500 No se puede canjear el cupón.

API-v2.1.0

Transform your PDFs into Flipbooks and boost your revenue!

Delete template?

Save as template ?