| Parameter | Description |
|---|---|
customer_email |
The customer_id of your application |
customer_password |
The customer_password of your application |
200 The user has been successfully authenticated and return its data.
{
"data":{
"status":200,
"body":{
"customer_id":"cus_LnTgrKREDRGY7",
"customer_name":"John Doe",
"customer_email":"[email protected]",
"subscription_status":"active",
"payment_method":"stripe",
"last_login":"2023-11-14 22:13:59"
},
"message":"Access granted"
}
}
403 The user has not been successfully authenticated because their email was not found.
{
"data":{
"status":403,
"body": null,
"message":"Access forbidden, User email does not exist"
}
}
403 The user has not been successfully authenticated because their password was incorrect.
{
"data": {
"status": 403,
"body": null,
"message": "Access forbidden, Incorrect password"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of client |
| Parameter | Description |
|---|---|
payment_method |
The payment_method means the customer's subscription type |
in-app-purchase |
in-app-purchase: app client |
stripe |
stripe: stripe client |
paypal |
paypal: paypal client |
null |
If this is null, It means this customer does not have a subscription |
200 Return customer data.
{
"data": {
"status": 200,
"body": {
"customer_id": "cus_PCC2WTJntr558e",
"customer_name": "Ana Rosa Escobar ",
"customer_email": "[email protected]",
"payment_method": null,
"subscription_status": "without"
},
"message": ""
}
}
404 Customer id was not found.
{
"data": {
"status": 404,
"body": null,
"message": "No se encontro el id de cliente recibido"
}
}
403 No customer_id received.
{
"data": {
"status": 403,
"body": null,
"message": "No se recibió id de Cliente"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of client |
200 Deleted account.
{
"data": {
"status": 200,
"body": null,
"message": "Tu cuenta ha sido cancelada"
}
}
403 The subscription must have a canceled status in order to cancel the customer's account.
{
"data": {
"status": 403,
"body": null,
"message": "Para cancelar tu cuenta, es necesario cancelar tu suscripción, contacta con soporte"
}
}
403 No customer_id received.
{
"data": {
"status": 403,
"body": null,
"message": "No se recibió id de Cliente"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of your application |
subscription_status |
The subscription_status define which content is available for the user. |
active |
All content is available for this user |
|
canceled |
Content is not available for this user |
200 The user has been found and return its subscription status.
{
"data":{
"status":200,
"body":{
"customer_id":"cus_LnTgrKREDRGY7",
"subscription_status":"active",
},
"message":""
}
}
403 If customer_id is missing.
{
"data":{
"status":403,
"body":null,
"message":"Customer id is required"
}
}
403 Customer id does not exist.
{
"data":{
"status":404,
"body":null,
"message":"Customer id does not exist"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of your application |
payment_method |
The payment_method the new payment method of the user. |
subscription_status |
The subscription_status define which content is available for the user. |
active |
All content is available for this user |
|
canceled |
Content is not available for this user |
200 The Customer has been found and their status has been updated.
{
"data": {
"status": 200,
"body": {
"customer_id": "ios_iP8R7Tw5cFt43W",
"subscription_status": "canceled"
},
"message": "Customer status updated successfully"
}
}
403 If customer_id is missing.
{
"data":{
"status":403,
"body":null,
"message":"Customer id is required"
}
}
404 If customer_id was not found.
{
"data":{
"status":404,
"body":null,
"message":"Customer id does not exist"
}
}
403 Could not update Customer status.
{
"data":{
"status":403,
"body":null,
"message":"Could not update Customer status"
}
}
| Parameter | Description |
|---|---|
weekly_calendar_name |
The weekly_calendar_name is the section title |
200 Getting calendar data.
{
"data": {
"status": 200,
"body": [
{
"id": "1",
"weekly_calendar_name": "HIGHER LEVEL CLASS",
"week": [
{
"day": "Lunes",
"title": "40 MINUTOS FULL BODY STRONG PILATES",
"video_id": "10321",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_25-5.jpg"
},
{
"day": "Martes",
"title": "30 MINUTOS SPICY LOW IMPACT CARDIO",
"video_id": "934",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_1251.png"
},
{
"day": "Miércoles",
"title": "30 MINUTOS LOWER BODY",
"video_id": "689",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_42.png"
},
{
"day": "Jueves",
"title": "20 MINUTOS PILATES FULL BODY BURN",
"video_id": "903",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_12-41.png"
},
{
"day": "Viernes",
"title": "25 MINUTOS CORE SCULPT + BURN",
"video_id": "10309",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_22-2.jpg"
},
{
"day": "Sábado",
"title": "45 MINUTOS FULL BODY PILATES SCULPT",
"video_id": "11019",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_28.png"
},
{
"day": "Domingo",
"title": "REST DAY",
"video_id": null,
"video_poster": null
}
]
},
{
"id": "2",
"weekly_calendar_name": "BEGINNERS CLASS",
"week": [
{
"day": "Lunes",
"title": "20 MINUTOS POWER HOUSE PILATES",
"video_id": "1010",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_8-3.jpg"
},
{
"day": "Martes",
"title": "30 MINUTOS FEEL GOOD PILATES",
"video_id": "1012",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_10-32.jpg"
},
{
"day": "Miércoles",
"title": "30 MINUTOS LOWER BODY ",
"video_id": "689",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_42.png"
},
{
"day": "Jueves",
"title": "25 MINUTOS POSTURA Y BRAZOS",
"video_id": "1013",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_93.png"
},
{
"day": "Viernes",
"title": "15 MINUTOS TONED LEGS BEGINNERS",
"video_id": "1015",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_8-5.jpg"
},
{
"day": "Sábado",
"title": "45 MINUTOS FULL BODY PILATES SCULPT",
"video_id": "11019",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_28.png"
},
{
"day": "Domingo",
"title": "REST DAY",
"video_id": null,
"video_poster": null
}
]
}
],
"message": ""
}
}
404 No results found.
{
"data":{
"status":404,
"body":null,
"message":"No results found"
}
}
| Parameter | Description |
|---|---|
customer_name |
The customer_name that is registering for the Application |
customer_password |
The customer_password must be at least 3 characters |
customer_email |
The customer_email must be unique |
200 The customer successfully registered and returned their details and generated customer_id
The subscription_status is set "without" as default
{
"data": {
"status": 200,
"body": {
"customer_id": "ios_4A12xTKtLJouza",
"customer_name": "proxyman",
"customer_email": "[email protected]",
"subscription_status": "without"
},
"message": "Customer was successfully registered"
}
}
403 If one or all of the customer data fields are missing
{
"data": {
"status": 403,
"body": null,
"message": "Completa los campos correctamente",
"validation_form_errors": {
"customer_name": "Tu usuario debe contener como mínimo 3 caracteres",
"customer_password": "Tu contraseña debe contener al menos 5 caracteres",
"customer_email": "Ingresa tu correo electrónico"
}
}
}
403 No data received
{
"data":{
"status":404,
"body":null,
"message":"No data received"
}
}
| Parameter | Description |
|---|---|
status |
If the "status" property is "hide", means that this category has no videos to show, in that case this category should be hide. |
video_poster |
The video_poster is showing as a poster for each video instead of video_category_poster |
200 Get a maximum of 10 videos for each category
{
"data": {
"status": 200,
"body": [
{
"video_category_id": "top-workouts-2023",
"video_category_name": "TOP WORKOUTS DEL 2023",
"video_category_poster": null,
"is_challenge": "no",
"order": "40",
"status": "hide",
"videos": []
},
{
"video_category_id": "back-to-classics",
"video_category_name": "BACK TO CLASSICS",
"video_category_poster": null,
"is_challenge": "no",
"order": "50",
"status": "show",
"videos": [
{
"id": "11018",
"video_order": null,
"video_category_id": "back-to-classics",
"video_duration": "Calendario",
"video_title": "Back to Classics",
"video_challenge_name_for_order": null,
"video_is_challenge": null,
"video_is_fixed_content": null,
"video_challenge_week": null,
"video_challenge_episode": null,
"video_challenge_label": null,
"filter_duration": null,
"filter_difficulty": null,
"filter_focus_area": null,
"active": "yes",
"video_description": "",
"video_poster": "https:\/\/amandacaballero.com\/assets\/videos\/WEEKLY_CALENDAR_copy-2.jpg",
"video_file": null,
"video_pdf": "WEEKLY_CALENDAR_copy.pdf",
"video_already_finished": null,
"active_date": null,
"main": null
},...
],
"message": ""
}
}
| Parameter | Description |
|---|---|
status |
If the "status" property is "show", means that this category has videos to show, in that case this category should be visible. |
video_category_poster |
The video_category_poster is showing as a poster for each program |
200 Get categories where is_challenge is yes
{
"data": {
"status": 200,
"body": [
{
"video_category_id": "7-days-core-challenge",
"video_category_name": "7 DAYS CORE CHALLENGE",
"video_category_poster": "https:\/\/amandacaballero.com\/assets\/videos\/poster-7days.jpg",
"is_challenge": "yes",
"order": "48",
"status": "show"
},
{
"video_category_id": "booty-burn-challenge",
"video_category_name": "BOOTY BURN CHALLENGE",
"video_category_poster": "https:\/\/amandacaballero.com\/assets\/videos\/poster-booty.jpg",
"is_challenge": "yes",
"order": "49",
"status": "show"
},
{
"video_category_id": "programa-2-semanas-para-principiantes",
"video_category_name": "PROGRAMA 2 SEMANAS PARA PRINCIPIANTES",
"video_category_poster": "https:\/\/amandacaballero.com\/assets\/videos\/poster-2semanas.jpg",
"is_challenge": "yes",
"order": "51",
"status": "show"
},...
],
"message": ""
}
}
| Parameter | Description |
|---|---|
category_id |
The category_id of the category |
200 Get all active videos in a category
{
"data":{
"status":200,
"body":[
{
"video_category_id":"back-to-classics",
"video_category_name":"BACK TO CLASSICS",
"video_category_poster":null,
"is_challenge":"no",
"videos":[
{
"video_category_id":"back-to-classics",
"video_duration":"7- 30 Minutos",
"video_title":"Big Booty Long Legs ",
"video_is_challenge":"yes",
"filter_duration":null,
"filter_difficulty":null,
"filter_focus_area":null,
"video_description":"Clase de sculpt - tonificaci\u00f3n de gl\u00fateos trabajando de adentro hacia fuera y todo a sus alrededores perfecta para un buen booty lift y tambi\u00e9n trabajando la tonificaci\u00f3n y alargamiento de piernas usando polainas.",
"video_poster":"YouTube_Thumbnail_copy_9-1311.png",
"video_file":"https:\/\/video.com\/1234",
"video_pdf":null,
"video_already_finished":null
},
{
"video_category_id":"back-to-classics",
"video_duration":"D\u00cdA 6 - 27 Minutos",
"video_title":"Pilates Full Body",
"video_is_challenge":"yes",
"filter_duration":null,
"filter_difficulty":null,
"filter_focus_area":null,
"video_description":"Clase perfecta para principiantes o para repasar tus bases de Pilates para poder maximizar tu workout sintiendo los movimientos con mas profundidad y enfoque.",
"video_poster":"YouTube_Thumbnail_copy_11-222.png",
"video_file":"https:\/\/vimeo.com\/762757789",
"video_pdf":null,
"video_already_finished":null
},
]
}
],
"message":""
}
}
| Parameter | Description |
|---|---|
video_id |
The video_id of the video |
customer_id |
The customer_id of the client |
{
"data": {
"status": 200,
"body": [
{
"id": "695",
"video_category_id": "cardio-hiit-pilates,cuerpo-completo-con-equipo,lives-on-demand,reto-move-align-challenge,reto-summer-challenge,workouts-16-30-minutos",
"video_duration": "DÍA 6- 30 Minutos ",
"video_title": "HIIT Pilates Standing Series + Meditación",
"video_is_challenge": "yes",
"filter_duration": "+30",
"filter_difficulty": "Intermedio",
"filter_focus_area": "Cuerpo completo",
"video_description": "Nivel: intermedio\r\nEquipo: polainas\r\nDuración: 35 mins workout + 15 mins meditación\r\n una clase muy dinámica incrementando ritmo cardiaco para sentir ese boost de endorfinas. Trabajando cuerpo completo. Terminando con una meditación de conexión y sanación de niña interior.",
"video_poster": "YouTube_Thumbnail_copy_10.jpg",
"video_file": "https://vimeo.com/713304079",
"video_pdf": null,
"video_already_finished": null,
"is_favorite": false,
"is_completed": true,
"related_videos": [
{
"id": "695",
"video_order": null,
"video_category_id": "cardio-hiit-pilates,cuerpo-completo-con-equipo,lives-on-demand,reto-move-align-challenge,reto-summer-challenge,workouts-16-30-minutos",
"video_duration": "DÍA 6- 30 Minutos ",
"video_title": "HIIT Pilates Standing Series + Meditación",
"video_challenge_name_for_order": "reto-move-align-challenge",
"video_is_challenge": "yes",
"video_is_fixed_content": null,
"video_challenge_week": "1",
"video_challenge_episode": "6",
"video_challenge_label": null,
"filter_duration": "+30",
"filter_difficulty": "Intermedio",
"filter_focus_area": "Cuerpo completo",
"active": "yes",
"video_description": "Nivel: intermedio\r\nEquipo: polainas\r\nDuración: 35 mins workout + 15 mins meditación\r\n una clase muy dinámica incrementando ritmo cardiaco para sentir ese boost de endorfinas. Trabajando cuerpo completo. Terminando con una meditación de conexión y sanación de niña interior.",
"video_poster": "https://amandacaballero.com/assets/videos/YouTube_Thumbnail_copy_10.jpg",
"video_file": "https://vimeo.com/713304079",
"video_pdf": null,
"video_already_finished": null,
"active_date": null,
"main": null
}
]
}
],
"message": ""
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of the client |
200 Get all videos of the playlist
{
"data": {
"status": 200,
"body": {
"section": {
"title": "Mi Playlist",
"subtitle": null,
"header": "https://cdn.amandacaballero.com/headers/mi_playlist.jpg"
},
"0": {
"id": "259",
"video_duration": "50 Minutos",
"video_title": "Full Body Tone + Sculpt",
"filter_difficulty": "Intermedio",
"video_poster": "https://amandacaballero.com/assets/videos/SCULPT_AND_TONE.png"
}
},
"message": ""
}
}
403 This customer does not have videos in their playlist
{
"data": {
"status": 403,
"body": null,
"message": "No tienes videos agregados a tu playlist"
}
}
404 This customer was not found
{
"data": {
"status": 404,
"body": null,
"message": "No se encontro el id de cliente recibido"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of the client |
video_id |
The video_id to add to favorites |
200 The video was added to the client's playlist
{
"data": {
"status": 200,
"body": [
{
"id": "11023",
"video_category_id": "top-workouts-2023",
"video_duration": "20 Minutos",
"video_title": "Pilates Strong"
}
],
"message": "Video agregado a tu playlist"
}
}
200 This video already exists in the client's playlist
{
"data": {
"status": 200,
"body": [
{
"id": "11023",
"video_category_id": "top-workouts-2023",
"video_duration": "20 Minutos",
"video_title": "Pilates Strong"
}
],
"message": "Este video ya existe en tu playlist"
}
}
403 This customer_id was not found
{
"data": {
"status": 403,
"body": null,
"message": "Cliente no válido"
}
}
404 This video_id was not found
{
"data": {
"status": 404,
"body": null,
"message": "El video requerido no existe o ya no se encuentra disponible"
}
}
| Parameter (URL) | Description |
|---|---|
customer_id |
The customer_id of the client |
video_id |
The video_id to delete |
200 video deleted
{
"data": {
"status": 200,
"body": null,
"message": "Video eliminado correctamente"
}
}
403 customer_id and video_id are required
{
"data": {
"status": 403,
"body": null,
"message": "Customer Id y video Id son requeridos"
}
}
404 video_id was not found
{
"data": {
"status": 404,
"body": null,
"message": "El video que deseas eliminar no existe o ya no está disponible"
}
}
| Parameter (URL) | Description |
|---|---|
customer_id |
The customer_id of the client |
video_id |
The video_id to delete |
200 video deleted
{
"data": {
"status": 200,
"body": null,
"message": "Video eliminado correctamente"
}
}
403 customer_id and video_id are required
{
"data": {
"status": 403,
"body": null,
"message": "Customer Id y video Id son requeridos"
}
}
404 video_id was not found
{
"data": {
"status": 404,
"body": null,
"message": "El video que deseas eliminar no existe o ya no está disponible"
}
}
| Parameter | Description |
|---|---|
customer_id |
The customer_id of the client |
video_id |
The video_id to mark as completed |
200 The video was mark as completed
{
"data": {
"status": 200,
"body": [
{
"id": "90",
"video_category_id": "post-natal-y-pre-natal,workouts-16-30-minutos",
"video_duration": "25 Minutos ",
"video_title": "Flow Postnatal con Pelota"
}
],
"message": "Video marcado como completado"
}
}
200 This video is now marked as completed
{
"data": {
"status": 200,
"body": [
{
"id": "11023",
"video_category_id": "top-workouts-2023",
"video_duration": "20 Minutos",
"video_title": "Pilates Strong"
}
],
"message": "Este video ya lo marcaste como completado"
}
}
403 This customer_id was not found
{
"data": {
"status": 403,
"body": null,
"message": "Cliente no válido"
}
}
404 This video_id was not found
{
"data": {
"status": 404,
"body": null,
"message": "El video requerido no existe o ya no se encuentra disponible"
}
}
| Filter name |
|---|
Duration |
Difficulty |
Focus areas |
200 Returns the filter values
{
"data": {
"status": 200,
"body": {
"duration": [
{
"id": "4",
"duration_value": "5-15"
},
{
"id": "5",
"duration_value": "15-30"
},
{
"id": "6",
"duration_value": "+30"
}
],
"difficulty": [
{
"id": "1",
"difficulty_value": "Principiante"
},
{
"id": "2",
"difficulty_value": "Intermedio"
},
{
"id": "3",
"difficulty_value": "Avanzado"
}
],
"areas": [
{
"id": "1",
"focus_area_name": "Abs & core"
},
{
"id": "2",
"focus_area_name": "Gl\u00fateos & cuerpo bajo"
},
{
"id": "3",
"focus_area_name": "Brazos, espalda & hombros"
},
{
"id": "4",
"focus_area_name": "Cuerpo completo"
}
]
},
"message": ""
}
}
404 No se encontraron resultados
{
"data": {
"status": 404,
"body": null,
"message": "No se encontraron resultados"
}
}
| Params | Options |
|---|---|
duration: |
5-15, 15-30, +30 |
difficulty: |
Principiante, Intermedio, Avanzado |
areas: |
Abs & core, Glúteos & cuerpo bajo, Brazos, espalda & hombros, Cuerpo completo |
200 Returns videos
{
"data": {
"status": 200,
"body": {
"videos": [
{
"id": "546",
"video_order": null,
"video_category_id": "abdomen",
"video_duration": "15 Minutos",
"video_title": "Abs Burner con Liga",
"video_challenge_name_for_order": "reto-winter-challenge",
"video_is_challenge": "yes",
"video_is_fixed_content": null,
"video_challenge_week": "1",
"video_challenge_episode": "5",
"video_challenge_label": null,
"filter_duration": "5-15",
"filter_difficulty": "Intermedio",
"filter_focus_area": "Abs & core",
"active": "yes",
"video_description": "Listas para sentir esos abs?! Con la ayuda de liga y de movimientos muy específicos trabajamos desde lo mas profundo nuestro abdomen transversal.",
"video_poster": "YouTube_Thumbnail_copy_117.jpg",
"video_file": "https://vimeo.com/766519235",
"video_pdf": null,
"video_already_finished": null,
"active_date": null,
"main": null
},
{
"id": "931",
"video_order": null,
"video_category_id": "abdomen",
"video_duration": "15 Minutos",
"video_title": "Power Abs",
"video_challenge_name_for_order": null,
"video_is_challenge": "yes",
"video_is_fixed_content": null,
"video_challenge_week": "1",
"video_challenge_episode": "5",
"video_challenge_label": null,
"filter_duration": "5-15",
"filter_difficulty": "Intermedio",
"filter_focus_area": "Abs & core",
"active": "yes",
"video_description": "Nivel: intermedio\r\nEquipo: propio peso\r\nDuracion: 15 Minutos\r\nFase Hormonal: Folicular",
"video_poster": "YouTube_Thumbnail_copy_12-521.png",
"video_file": "https://vimeo.com/817005390",
"video_pdf": null,
"video_already_finished": null,
"active_date": null,
"main": null
}
]
},
"message": "Se encontraron 2 resultados"
}
}
404 No se encontraron resultados
{
"data": {
"status": 404,
"body": null,
"message": "No se recibieron filtros de búsqueda, prueba seleccionando una combinación de filtros"
}
}
| Params | Options |
|---|---|
searchterm: |
Search term |
200 Returns videos
{
"data": {
"status": 200,
"body": {
"videos": [
{
"id": "546",
"video_order": null,
"video_category_id": "abdomen",
"video_duration": "15 Minutos",
"video_title": "Abs Burner con Liga",
"video_challenge_name_for_order": "reto-winter-challenge",
"video_is_challenge": "yes",
"video_is_fixed_content": null,
"video_challenge_week": "1",
"video_challenge_episode": "5",
"video_challenge_label": null,
"filter_duration": "5-15",
"filter_difficulty": "Intermedio",
"filter_focus_area": "Abs & core",
"active": "yes",
"video_description": "Listas para sentir esos abs?! Con la ayuda de liga y de movimientos muy específicos trabajamos desde lo mas profundo nuestro abdomen transversal.",
"video_poster": "YouTube_Thumbnail_copy_117.jpg",
"video_file": "https://vimeo.com/766519235",
"video_pdf": null,
"video_already_finished": null,
"active_date": null,
"main": null
}
]
},
"message": "Se encontraron 1 resultados"
}
}
404 No se encontraron resultados
{
"data": {
"status": 404,
"body": null,
"message": No se encontraron resultados"
}
}