Created
June 15, 2020 13:23
-
-
Save silassare/01366eec3a628443ab4ee5a1bcd0b540 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.0", | |
"info": { | |
"title": "Learnybox API", | |
"version": "2.0" | |
}, | |
"servers": [ | |
{ | |
"url": "/", | |
"description": "" | |
} | |
], | |
"paths": { | |
"/api/v2/activities/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Liste des activités", | |
"operationId": "api_v2_activities_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 1, | |
"viewed": false, | |
"transaction": [], | |
"type": "transaction" | |
}, | |
{ | |
"id": 2, | |
"viewed": false, | |
"comment": [], | |
"type": "comment" | |
}, | |
{ | |
"id": 3, | |
"viewed": false, | |
"page_comment": [], | |
"type": "page_comment" | |
}, | |
{ | |
"id": 4, | |
"viewed": false, | |
"formation_comment": [], | |
"type": "formation_comment" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/activities/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/activities/{id}/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Données d'une activité", | |
"operationId": "api_v2_activities_show", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 1, | |
"viewed": false, | |
"transaction": [], | |
"type": "transaction" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/comment_activities/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Liste des activités de type commentaire", | |
"operationId": "api_v2_activities_comments_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 2, | |
"viewed": false, | |
"comment": [], | |
"type": "comment" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/comment_activities/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/comment_activities/{id}/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Données d'une activité de type commentaire", | |
"operationId": "api_v2_activities_comments_show", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 2, | |
"viewed": false, | |
"comment": [], | |
"type": "comment" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formation_comment_activities/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Liste des activités de type formation commentaire", | |
"operationId": "api_v2_activities_comments_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 2, | |
"viewed": false, | |
"formation_comment": [], | |
"type": "formation_comment" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formation_comment_activities/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formation_comment_activities/{id}/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Données d'une activité de type formation commentaire", | |
"operationId": "api_v2_activities_comments_show", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 2, | |
"viewed": false, | |
"formation_comment": [], | |
"type": "formation_comment" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/page_comment_activities/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Liste des activités de type page commentaire", | |
"operationId": "api_v2_activities_comments_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 2, | |
"viewed": false, | |
"page_comment": [], | |
"type": "page_comment" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/page_comment_activities/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/page_comment_activities/{id}/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Données d'une activité de type page commentaire", | |
"operationId": "api_v2_activities_comments_show", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 2, | |
"viewed": false, | |
"page_comment": [], | |
"type": "page_comment" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/transaction_activities/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Liste des activités de type transaction", | |
"operationId": "api_v2_activities_transactions_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 2, | |
"viewed": false, | |
"transaction": [], | |
"type": "transaction" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/transaction_activities/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/transaction_activities/{id}/": { | |
"get": { | |
"tags": [ | |
"Activities" | |
], | |
"summary": "Données d'une activité de type transaction", | |
"operationId": "api_v2_activities_transactions_show", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 2, | |
"viewed": false, | |
"transaction": [], | |
"type": "transaction" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affilies/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Liste des affiliés", | |
"operationId": "api_v2_affiliations_affilies_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_affilie": 1, | |
"nom": "Learny", | |
"prenom": "Box1", | |
"email": "[email protected]", | |
"parent": 0, | |
"commentaire": "", | |
"approved": true, | |
"date": "2019-03-18T16:49:05+0100" | |
}, | |
{ | |
"id_affilie": 2, | |
"nom": "Learny", | |
"prenom": "Box1", | |
"email": "[email protected]", | |
"parent": 0, | |
"commentaire": "", | |
"approved": true, | |
"date": "2019-03-18T17:00:39+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/affilies/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affilies/{id_affilie}/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Données d'un affilié", | |
"operationId": "api_v2_affiliations_affilies_show", | |
"parameters": [ | |
{ | |
"name": "id_affilie", | |
"in": "path", | |
"description": "ID de l'affilié", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_affilie": 1, | |
"nom": "Learny", | |
"prenom": "Box1", | |
"email": "[email protected]", | |
"parent": 0, | |
"commentaire": "", | |
"approved": true, | |
"date": "2019-03-18T16:49:05+0100" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Supprimer un affilié", | |
"operationId": "api_v2_affiliations_affilies_delete", | |
"parameters": [ | |
{ | |
"name": "id_affilie", | |
"in": "path", | |
"description": "ID de l'affilié", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Activer - Désactiver un affilié", | |
"operationId": "api_v2_affiliations_affilies_activate", | |
"parameters": [ | |
{ | |
"name": "id_affilie", | |
"in": "path", | |
"description": "ID de l'affilié", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b>Au moins un des champs suivants obligatoire *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"activate": { | |
"description": "Activer ou désactiver un affilié", | |
"type": "boolean", | |
"enum": [ | |
"true", | |
"false" | |
] | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affilies/{id_affilie}/{action}/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Données et actions pour un affilié", | |
"operationId": "api_v2_affiliations_affilies_show_actions", | |
"parameters": [ | |
{ | |
"name": "id_affilie", | |
"in": "path", | |
"description": "ID de l'affilié", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "action", | |
"in": "path", | |
"description": "", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"stats", | |
"commissions", | |
"links", | |
"reinit_password", | |
"clients" | |
] | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affiliations/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Liste des campagnes de votre programme d'affiliation", | |
"operationId": "api_v2_affiliations_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_campaign": 1, | |
"nom": "Formation LearnyBox", | |
"image": "https://api.learnybox.com/images/ma-formation/13.jpeg", | |
"description": "<p>Gagnez 30% de commission sur chaque vente !</p>\\r\\n", | |
"type_commission": "pourcentage", | |
"montant_commission": 30, | |
"type_montant": "ht", | |
"type_commission2": "pourcentage", | |
"montant_commission2": 10, | |
"type_montant2": "ht", | |
"tva": 20, | |
"tva2015": true, | |
"cookie": 0, | |
"duree_garantie": 10, | |
"active": true, | |
"type": "publique", | |
"affilies": "11", | |
"position": 12, | |
"permalink": "5880d8", | |
"date": "2017-03-14T14:46:34+0100" | |
}, | |
{ | |
"id_campaign": 2, | |
"nom": "Formation LearnyBox 2", | |
"image": "https://api.learnybox.com/images/ma-formation/13.jpeg", | |
"description": "<p>Gagnez 30% de commission sur chaque vente !</p>\\r\\n", | |
"type_commission": "pourcentage", | |
"montant_commission": 30, | |
"type_montant": "ht", | |
"type_commission2": "pourcentage", | |
"montant_commission2": 10, | |
"type_montant2": "ht", | |
"tva": 20, | |
"tva2015": true, | |
"cookie": 0, | |
"duree_garantie": 10, | |
"active": true, | |
"type": "publique", | |
"affilies": "11", | |
"position": 12, | |
"permalink": "5880d8", | |
"date": "2017-03-14T14:46:34+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/affiliations/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affiliations/{id_campaign}/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Données d'une campagne de votre programme d'affiliation", | |
"operationId": "api_v2_affiliations_show", | |
"parameters": [ | |
{ | |
"name": "id_campaign", | |
"in": "path", | |
"description": "ID de la campagne", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_campaign": 1, | |
"nom": "Formation LearnyBox", | |
"image": "https://api.learnybox.com/images/ma-formation/13.jpeg", | |
"description": "<p>Gagnez 30% de commission sur chaque vente !</p>\\r\\n", | |
"type_commission": "pourcentage", | |
"montant_commission": 30, | |
"type_montant": "ht", | |
"type_commission2": "pourcentage", | |
"montant_commission2": 10, | |
"type_montant2": "ht", | |
"tva": 20, | |
"tva2015": true, | |
"cookie": 0, | |
"duree_garantie": 10, | |
"active": true, | |
"type": "publique", | |
"affilies": "11", | |
"position": 12, | |
"permalink": "5880d8", | |
"date": "2017-03-14T14:46:34+0100" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Supprimer une campagne de votre programme d'affiliation", | |
"operationId": "api_v2_affiliations_delete", | |
"parameters": [ | |
{ | |
"name": "id_campaign", | |
"in": "path", | |
"description": "ID de la campagne", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Activer - Désactiver une campagne de votre programme d'affiliation", | |
"operationId": "api_v2_affiliations_activate", | |
"parameters": [ | |
{ | |
"name": "id_campaign", | |
"in": "path", | |
"description": "ID de la campagne", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b>Au moins un des champs suivants obligatoire *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"activate": { | |
"description": "Activer ou désactiver la campagne", | |
"type": "boolean", | |
"enum": [ | |
"true", | |
"false" | |
] | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/affiliations/{id_campaign}/stats/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Statistiques des affiliés pour une campagne", | |
"operationId": "api_v2_affiliations_stats", | |
"parameters": [ | |
{ | |
"name": "id_campaign", | |
"in": "path", | |
"description": "ID de la campagne", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/commissions/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Liste des commissions", | |
"operationId": "api_v2_commissions_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_commission": 1, | |
"type": "normal", | |
"produit": "test produit", | |
"montant": 89.21, | |
"commission": 20.32, | |
"etat": "valid", | |
"date": "2019-02-20T16:37:40+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/commissions/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Ajouter une commission", | |
"operationId": "api_v2_commissions_create", | |
"requestBody": { | |
"description": "<b>Champs id_campaign, id_affilie, montant et montant_commission obligatoires *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_campaign": { | |
"description": "Identifiant de la campagne", | |
"type": "integer" | |
}, | |
"id_affilie": { | |
"description": "Identifiant de l'affilié", | |
"type": "string" | |
}, | |
"montant": { | |
"description": "Montant de la vente", | |
"type": "string" | |
}, | |
"montant_commission": { | |
"description": "Montant de la commission", | |
"type": "string" | |
}, | |
"id_transaction": { | |
"description": "Identifiant de la transaction", | |
"type": "string" | |
}, | |
"produit": { | |
"description": "Nom du produit", | |
"type": "string" | |
}, | |
"ip": { | |
"description": "Adresse IP du client", | |
"type": "string" | |
}, | |
"date": { | |
"description": "Date de la commission (au format YYYY-MM-DD HH:MM:SS)", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-code-samples": [ | |
{ | |
"lang": "Form data", | |
"source": "id_campaign:1&id_affilie:1&montant:99.99&montant_commission:30&id_transaction:TEST0001&produit:test+produit&date:2019-02-20+16:37:40" | |
} | |
] | |
} | |
}, | |
"/api/v2/commissions/{id_comission}/": { | |
"get": { | |
"tags": [ | |
"Affiliations" | |
], | |
"summary": "Données d'une commission", | |
"operationId": "api_v2_commissions_show", | |
"parameters": [ | |
{ | |
"name": "id_comission", | |
"in": "path", | |
"description": "ID de la commission", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_commission": 1, | |
"type": "normal", | |
"produit": "test produit", | |
"montant": 89.21, | |
"commission": 20.32, | |
"etat": "valid", | |
"date": "2019-02-20T16:37:40+0100" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/oauth/token/": { | |
"post": { | |
"tags": [ | |
"Token d'authentification" | |
], | |
"summary": "Générer un access/refresh token", | |
"operationId": "api_v2_oauth_token", | |
"requestBody": { | |
"description": "<b>Champs grant_type obligatoire *</b> Api key obligatoire pour un access token", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"grant_type": { | |
"description": "", | |
"type": "string", | |
"enum": [ | |
"access_token", | |
"refresh_token" | |
] | |
}, | |
"refresh_token": { | |
"description": "valeur du refresh_token dans le cas d'une regénération d'un access token", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"access_token": "XXXXXXXXX", | |
"refresh_token": "YYYYYYYYY", | |
"token_type": "Bearer", | |
"expires_in": "00" | |
} | |
], | |
"message": "" | |
} | |
} | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"apiKeyAuth": [] | |
} | |
] | |
} | |
}, | |
"/api/v2/oauth/token/revoke/": { | |
"post": { | |
"tags": [ | |
"Token d'authentification" | |
], | |
"summary": "Révoquer un access token (et refresh token associé)", | |
"operationId": "api_v2_oauth_token_revoke", | |
"requestBody": { | |
"description": "<b>Champs access_token obligatoire *</b> Api key obligatoire pour supprimer un access token", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"access_token": { | |
"description": "access token à révoquer", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"apiKeyAuth": [] | |
} | |
] | |
} | |
}, | |
"/api/v2/conferences/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Liste des conferences", | |
"operationId": "api_v2_conferences_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_conference": 1, | |
"nom": "test conférence", | |
"date": "2019-03-14T14:00:00+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/conferences/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Données d'une conferences", | |
"operationId": "api_v2_conferences_show", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_conference": 1, | |
"nom": "test conférence", | |
"type_conf": "tokbox", | |
"accroche": "", | |
"description": "", | |
"nb_coaches": 0, | |
"nb_auditeurs": 9999, | |
"is_coache_payant": false, | |
"coache_productid": 0, | |
"is_auditeur_payant": false, | |
"auditeur_productid": 0, | |
"image_inscription": "", | |
"afficher_participants": false, | |
"delta_participants": 0, | |
"type": "privee", | |
"type_youtube": "privee", | |
"acces_conference": "inscription", | |
"type_inscription": "automatique", | |
"email_inscription": false, | |
"page_confirmation": "defaut", | |
"url_page_confirmation": "", | |
"theme_inscription": "1-1-1", | |
"theme_confirmation": "1-1-19", | |
"theme_attente": "", | |
"theme_broadcast": "", | |
"thumbnail": "", | |
"email_rappel": false, | |
"chat": "question", | |
"youtube": "", | |
"hangout_link": "", | |
"replay": false, | |
"replay_auto": false, | |
"replay_desactivation": 0, | |
"replay_redirection": "", | |
"replay_inscription": false, | |
"date": "2019-03-14T14:00:00+0100", | |
"date_timezone": "2019-03-14T14:00:00+0100", | |
"timezone": "Europe/Paris", | |
"date_diffusion": "-0001-11-30T00:00:00+0009", | |
"date_terminee": "-0001-11-30T00:00:00+0009", | |
"etat": "enattente", | |
"inscription_js": "", | |
"inscription_js_head": "", | |
"confirmation_js": "", | |
"confirmation_js_head": "", | |
"broadcast_js": "", | |
"broadcast_js_head": "", | |
"classilio_activity_i_d": "", | |
"classilio_user_i_d": "", | |
"broadcast": "", | |
"layout": "", | |
"rtmp": "", | |
"rgpd": true, | |
"rgpd_text": "En indiquant votre adresse mail, vous acceptez que nous vous invitions par mail à cette conférence et que nous vous adressions des offres personnalisées de formations. Vous pouvez vous désinscrire à tout moment en nous adressant un mail et à travers les liens de désinscription.", | |
"rgpd_aff": false, | |
"rgpd_aff_text": "En indiquant votre adresse mail, vous acceptez en échange de recevoir des offres commerciales de nos partenaires.", | |
"client": { | |
"nom_client": "Learny Box" | |
}, | |
"conference_chats": [ | |
{ | |
"id_chat": 4, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"message": "salut ! ", | |
"pinned": true, | |
"date": "2019-03-14T14:15:15+0100" | |
} | |
], | |
"conference_inscrits": [] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/chat/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Chat d'une conference", | |
"operationId": "api_v2_conferences_chat_list", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_chat": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"message": "salut ! ", | |
"pinned": true, | |
"date": "2019-03-14T14:15:15+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/conferences/1/chat/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/inscrits/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Liste des inscrits d'une conference", | |
"operationId": "api_v2_conferences_inscrits_list", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_inscrit": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-17T16:28:07+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"conference_user": { | |
"id_user": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "", | |
"disabled": false, | |
"newsletter": true, | |
"date_inscr": "2017-08-30T07:58:43+0200", | |
"rgpd": false, | |
"rgpd_aff": false, | |
"conference_inscrits": [] | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/conferences/1/inscrits/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/inscrits/{id_inscrit}/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Données d'un inscrit d'une conference", | |
"operationId": "api_v2_conferences_inscrits_show", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_inscrit", | |
"in": "path", | |
"description": "Identifiant d'un inscrit", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_inscrit": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-17T16:28:07+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"conference_user": { | |
"id_user": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "", | |
"disabled": false, | |
"newsletter": true, | |
"date_inscr": "2017-08-30T07:58:43+0200", | |
"rgpd": false, | |
"rgpd_aff": false, | |
"conference_inscrits": [] | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/messages/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Liste des messages d'une conference", | |
"operationId": "api_v2_conferences_messages_list", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_message": 1, | |
"message": "test message", | |
"date": "2019-04-30T16:08:08+0200" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/conferences/1/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/participants/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Liste des participants d'une conference", | |
"operationId": "api_v2_conferences_participants_list", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_participant": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-17T16:28:07+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"conference_user": { | |
"id_user": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "", | |
"disabled": false, | |
"newsletter": true, | |
"date_inscr": "2017-08-30T07:58:43+0200", | |
"rgpd": false, | |
"rgpd_aff": false, | |
"conference_participants": [] | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/conferences/1/participants/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/conferences/{id_conference}/participants/{id_participant}/": { | |
"get": { | |
"tags": [ | |
"Conferences" | |
], | |
"summary": "Données d'un participant d'une conference", | |
"operationId": "api_v2_conferences_participants_show", | |
"parameters": [ | |
{ | |
"name": "id_conference", | |
"in": "path", | |
"description": "Identifiant d'une conference", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_participant", | |
"in": "path", | |
"description": "Identifiant d'un participant", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_participant": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-17T16:28:07+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"conference_user": { | |
"id_user": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "", | |
"disabled": false, | |
"newsletter": true, | |
"date_inscr": "2017-08-30T07:58:43+0200", | |
"rgpd": false, | |
"rgpd_aff": false, | |
"conference_participants": [] | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste des formations", | |
"operationId": "api_v2_formations_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_formation": "103", | |
"nom": "Formation LearnyBox", | |
"type": "freeaccess_total", | |
"etat": "enable", | |
"lien": "https://api.learnybox.com/formation/index/", | |
"membres": "10", | |
"date": "2017-01-16 16:35:22" | |
}, | |
{ | |
"id_formation": "101", | |
"nom": "Ma première formation", | |
"type": "program", | |
"etat": "enable", | |
"lien": "https://api.learnybox.com/formation/index/", | |
"membres": "2", | |
"date": "2016-11-23 14:33:17" | |
} | |
], | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/commentaires/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste des commentaires d'une formation", | |
"operationId": "api_v2_formations_commentaires_list", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant d'une formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"display_etat": "Approuvé", | |
"id_commentaire": 1, | |
"idmodule": 1, | |
"commentaire": "nouveau commentaire test", | |
"etat": "approuve", | |
"notification": true, | |
"telephone": "0987654321", | |
"adresse": "25 rue de Learnybox 34000 Montpellier", | |
"site": "https://api.learnybox.com", | |
"date": "2019-04-23T14:14:15+0200" | |
}, | |
{ | |
"id_commentaire": 2, | |
"idmodule": 0, | |
"parent": 1, | |
"commentaire": "réponse du premier commentaire", | |
"etat": "approuve", | |
"notification": false, | |
"telephone": "", | |
"adresse": "", | |
"site": "", | |
"date": "2019-05-14T10:52:09+0200" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"rel": "self", | |
"href": "https://api.learnybox.com/api/v2/formations/1/commentaires/?limit=100&offset=0" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Ajouter un nouveau commentaire à une formation", | |
"operationId": "api_v2_formations_commentaires_create", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant d'une formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"idelement": { | |
"description": "", | |
"type": "integer" | |
}, | |
"idmodule": { | |
"description": "", | |
"type": "integer" | |
}, | |
"idpage": { | |
"description": "", | |
"type": "integer" | |
}, | |
"message": { | |
"description": "", | |
"type": "string" | |
}, | |
"site": { | |
"description": "URL du site", | |
"type": "string" | |
}, | |
"adresse": { | |
"description": "Adresse", | |
"type": "string" | |
}, | |
"telephone": { | |
"description": "Téléphone", | |
"type": "integer" | |
}, | |
"orig_comment": { | |
"description": "0 pour ne pas afficher le commentaire d'origine / 1 pour afficher le commentaire d'origine", | |
"type": "boolean" | |
}, | |
"notification": { | |
"description": "0 pour ne pas notifier / 1 pour notifier", | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-code-samples": [ | |
{ | |
"lang": "Form data", | |
"source": "idelement=1&idmodule=1&idpage=1&message=nouveau+commentaire+test&site=https://api.learnybox.com&adresse=25 rue de Learnybox 34000 Montpellier&telephone=0987654321&orig_comment=0¬ification=0" | |
} | |
] | |
} | |
}, | |
"/api/v2/formations/{id_formation}/commentaires/{id_commentaire}/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Données d'un commentaire d'une formation", | |
"operationId": "api_v2_formations_commentaires_show", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant d'une formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire de la formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"display_etat": "Approuvé", | |
"id_commentaire": 1, | |
"idmodule": 1, | |
"commentaire": "nouveau commentaire test", | |
"etat": "approuve", | |
"notification": true, | |
"telephone": "0987654321", | |
"adresse": "25 rue de Learnybox 34000 Montpellier", | |
"site": "https://api.learnybox.com", | |
"date": "2019-04-23T14:14:15+0200" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Mise à jour d'un commentaire d'une formation", | |
"operationId": "api_v2_formations_commentaires_edit", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant d'une formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"message": { | |
"description": "", | |
"type": "string" | |
}, | |
"site": { | |
"description": "URL du site", | |
"type": "string" | |
}, | |
"adresse": { | |
"description": "Adresse", | |
"type": "string" | |
}, | |
"telephone": { | |
"description": "Téléphone", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/commentaires/{id_commentaire}/": { | |
"delete": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Suppression d'un commentaire", | |
"operationId": "api_v2_site_formations_commentaires_delete", | |
"parameters": [ | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{idformation}/commentaires/reponse/": { | |
"post": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Ajouter une réponse à un commentaire d'une formation", | |
"operationId": "api_v2_formations_commentaires_response_create", | |
"parameters": [ | |
{ | |
"name": "idformation", | |
"in": "path", | |
"description": "Identifiant d'une formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"user_id": { | |
"description": "Identifiant de l'utilisateur", | |
"type": "integer" | |
}, | |
"idmodule": { | |
"description": "Identifiant du module", | |
"type": "integer" | |
}, | |
"idpage": { | |
"description": "Identifiant de la page", | |
"type": "integer" | |
}, | |
"orig_comment": { | |
"description": "Identifiant du commentaire d'origine", | |
"type": "integer" | |
}, | |
"message": { | |
"description": "Message", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/groupes/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste des groupes d'une formation", | |
"operationId": "api_v2_formations_groupes_list", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_groupe": "1", | |
"nom": "grouptest", | |
"modules": "[1,2]", | |
"pages": "[1,2,3]", | |
"date": "2019-04-23 14:24:38", | |
"nb_membres": "10" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/groupes/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/membres/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste de tous les membres d'une formation", | |
"operationId": "api_v2_formations_membres_list", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"user_id": 1, | |
"idgroupe": "0", | |
"active": true, | |
"datecreation": "2019-04-23T14:05:42+0200", | |
"datemodification": "2019-04-23T14:05:42+0200", | |
"dateinscription": "2019-04-23T14:05:42+0200", | |
"user": { | |
"user_id": 1, | |
"validated": 1, | |
"contact_technique": 0, | |
"fname": "Learny 1", | |
"lname": "Box", | |
"email": "[email protected]", | |
"newsletter": true, | |
"rgpd": false, | |
"rgpd_aff": false, | |
"user_configs": [] | |
} | |
}, | |
{ | |
"user_id": 2, | |
"idgroupe": "0", | |
"active": true, | |
"datecreation": "2019-04-23T14:05:42+0200", | |
"datemodification": "2019-04-23T14:05:42+0200", | |
"dateinscription": "2019-04-23T14:05:42+0200", | |
"user": { | |
"user_id": 2, | |
"validated": 1, | |
"contact_technique": 0, | |
"fname": "Learny 2", | |
"lname": "Box", | |
"email": "[email protected]", | |
"newsletter": false, | |
"rgpd": false, | |
"rgpd_aff": false, | |
"user_configs": [] | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/membres/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Ajouter un membre à une formation", | |
"operationId": "api_v2_formations_membres_create", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/membres/progression/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Récupérer la progression des membres d'une formation", | |
"operationId": "api_v2_formations_membres_progression", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"nom": "my formation", | |
"link": "https://my-formation.learnybox.com", | |
"etat": "enable", | |
"type": "program", | |
"theme": "focuson", | |
"datecreation": "2019-04-23 14:05:42", | |
"membres": [ | |
{ | |
"id_membre": "1", | |
"prenom": "Learny", | |
"nom": "Box", | |
"email": "[email protected]", | |
"groupes": "1", | |
"progression": "0%" | |
} | |
] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/membres/{id_membre}/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Données d'un membre d'une formation", | |
"operationId": "api_v2_formations_membres_show", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_membre", | |
"in": "path", | |
"description": "Identifiant d'un membre", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_membre": "1", | |
"prenom": "Learny", | |
"nom": "Box", | |
"email": "[email protected]", | |
"pseudo": "", | |
"adresse": "", | |
"code_postal": "", | |
"ville": "", | |
"pays": "FR", | |
"tel": "", | |
"formations": [ | |
{ | |
"id_formation": "1", | |
"nom": "my formation", | |
"groupes": "1", | |
"datecreation": "2019-04-23 14:22:30", | |
"type": "program", | |
"acces": "active" | |
} | |
] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Supprimer un membre d'une formation", | |
"operationId": "api_v2_formations_membres_delete", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_membre", | |
"in": "path", | |
"description": "Identifiant d'un membre", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Editer un membre d'une formation", | |
"operationId": "api_v2_formations_membres_edit", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_membre", | |
"in": "path", | |
"description": "Identifiant d'un membre", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b>Au moins un des champs suivants obligatoire *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"nom": { | |
"description": "Nouveau nom du membre", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Nouveau prénom du membre", | |
"type": "string" | |
}, | |
"new_email": { | |
"description": "Nouvelle adresse email du membre", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/membres/{id_membre}/messages/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Messages d'un membre pour une formation", | |
"operationId": "api_v2_formations_membres_messages_show", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_membre", | |
"in": "path", | |
"description": "Identifiant d'un membre", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_message": 1, | |
"destinataires": "", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"type": "test message", | |
"priorite": "Moyenne", | |
"message": "<p>test content message </p>\\r\\n", | |
"attachments": "[]", | |
"parent": 0, | |
"admin": true, | |
"lu": false, | |
"lu_admin": true, | |
"date": "2019-03-13T15:37:32+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/membres/1/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/membres/{id_membre}/coachings/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Coachings d'un membre pour une formation", | |
"operationId": "api_v2_formations_membres_coachings_show", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_membre", | |
"in": "path", | |
"description": "Identifiant d'un membre", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"idformation": 1, | |
"idmodule": 0, | |
"idpage": 0, | |
"label_expediteur": "", | |
"sujet": "Mon document", | |
"message": "voici mon document, merci de me dire ce que vous en pensez.", | |
"type": "fichier", | |
"date": "2017-11-14T10:38:54+0100", | |
"etat": "repondu", | |
"date_reponse": "2017-01-17T13:56:26+0100", | |
"reponse": "<p>Bonjour,</p>\\r\\n\\r\\n<p>voici ma correction.</p>\\r\\n", | |
"lu": true | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/membres/1/coachings/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/messages/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste des messages postés depuis la plateforme de formation", | |
"operationId": "api_v2_formations_messages_list", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_message": 1, | |
"destinataires": "", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"type": "test message", | |
"priorite": "Moyenne", | |
"message": "<p>test content message </p>\\r\\n", | |
"attachments": "[]", | |
"parent": 0, | |
"admin": true, | |
"lu": false, | |
"lu_admin": true, | |
"date": "2019-03-13T15:37:32+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/messages/{id_message}/": { | |
"delete": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Suppression d'un message posté depuis la plateforme de formation", | |
"operationId": "api_v2_formations_messages_delete", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_message", | |
"in": "path", | |
"description": "Identifiant message", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/formations/{id_formation}/modules/": { | |
"get": { | |
"tags": [ | |
"Formations" | |
], | |
"summary": "Liste des modules parent (de premier niveau) d'une formation", | |
"operationId": "api_v2_formations_modules_list", | |
"parameters": [ | |
{ | |
"name": "id_formation", | |
"in": "path", | |
"description": "Identifiant formation", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"idmodule": 1, | |
"nommodule": "Module 1", | |
"description": "description module 1", | |
"vignette": "", | |
"difficulte": 0, | |
"duree": 0, | |
"delay": 0, | |
"date_start": "-0001-11-30T00:00:00+0009", | |
"parent": 0, | |
"position": 2, | |
"notification": false, | |
"etat": "publie", | |
"datecreation": "2019-04-23T14:05:43+0200", | |
"datemodification": "2019-04-23T12:05:43+0200" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/formations/1/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/blogbroadcasts/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des newsletters", | |
"operationId": "api_v2_mail_blogbroadcasts_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_blog_broadcast": 1, | |
"nom": 1, | |
"feed_url": "https://api.learnybox.com/feed/", | |
"id_mail": "1", | |
"jour_envoi": "['lundi']", | |
"heure_envoi": "10", | |
"timezone": "Europe/Paris", | |
"nb_article": "1", | |
"sequences": "[]", | |
"exclude_sequences": "[]", | |
"tags": "[]", | |
"exclude_tags": "[]", | |
"nb_envoi": "0", | |
"nb_opens": "0", | |
"etat": "active", | |
"date_creation": "2019-01-01T12:00:00+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/blogbroadcasts/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/contacts/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des contacts", | |
"operationId": "api_v2_mail_contacts_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_contact": "1", | |
"prenom": "Learny", | |
"nom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"code_postal": "", | |
"ville": "", | |
"pays": "", | |
"tel": "", | |
"etat": "subscribed", | |
"date_inscription": "2019-03-15 12:01:06", | |
"date_desinscription": "" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/contacts/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Inscrire un nouveau contact", | |
"operationId": "api_v2_mail_contacts_create", | |
"requestBody": { | |
"description": "<b>Champs nom, prenom et email obligatoires *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"nom": { | |
"description": "Nom du contact", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Prénom du contact", | |
"type": "string" | |
}, | |
"email": { | |
"description": "Adresse email du contact", | |
"type": "string" | |
}, | |
"id_sequence": { | |
"description": "Identifiant d'une séquence", | |
"type": "string" | |
}, | |
"tags": { | |
"description": "Identifiant des tags séparés par une virgule", | |
"type": "string" | |
}, | |
"adresse": { | |
"description": "Adresse du contact", | |
"type": "string" | |
}, | |
"ville": { | |
"description": "Ville du contact", | |
"type": "string" | |
}, | |
"pays": { | |
"description": "Pays du contact", | |
"type": "string" | |
}, | |
"code_postal": { | |
"description": "Code postal du contact", | |
"type": "string" | |
}, | |
"tel": { | |
"description": "Numéro de téléphone du contact", | |
"type": "string" | |
}, | |
"rgpd": { | |
"description": "0 pour non qualifié RGPD / 1 pour qualifié RGPD", | |
"type": "boolean" | |
}, | |
"rgpd_notice": { | |
"description": "Texte du consentement", | |
"type": "string" | |
}, | |
"rgpd_aff": { | |
"description": "0 pour non qualifié RGPD Partenaires / 1 pour qualifié RGPD Partenaires", | |
"type": "boolean" | |
}, | |
"rgpd_date": { | |
"description": "Date au format YYYY-MM-DD de la qualification RGPD du contact ou de la qualification RGPD Partenaires du contact (obligatoire si rgpd = 1 ou rgpd_aff = 1)", | |
"type": "string" | |
}, | |
"rgpd_aff_notice": { | |
"description": "Texte du consentement", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-code-samples": [ | |
{ | |
"lang": "Form data", | |
"source": "id_campaign:1&id_affilie:1&montant:99.99&montant_commission:30&id_transaction:TEST0001&produit:test+produit&date:2019-02-20+16:37:40" | |
} | |
] | |
}, | |
"patch": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Mise à jour d'un contact", | |
"operationId": "api_v2_mail_contacts_edit", | |
"requestBody": { | |
"description": "<b>Champs id_contact, email(si pas d'identifiant d'un contact) obligatoires *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_contact": { | |
"description": "Identifiant d'un contact", | |
"type": "integer" | |
}, | |
"email": { | |
"description": "Adresse email du contact (obligatoire si pas d'identifiant d'un contact)", | |
"type": "string" | |
}, | |
"nom": { | |
"description": "Nouveau nom du contact", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Nouveau prénom du contact", | |
"type": "string" | |
}, | |
"new_email": { | |
"description": "Nouvelle adresse email du contact", | |
"type": "string" | |
}, | |
"rgpd": { | |
"description": "0 pour non qualifié RGPD / 1 pour qualifié RGPD", | |
"type": "boolean" | |
}, | |
"rgpd_notice": { | |
"description": "Texte du consentement", | |
"type": "string" | |
}, | |
"rgpd_aff": { | |
"description": "0 pour non qualifié RGPD Partenaires / 1 pour qualifié RGPD Partenaires", | |
"type": "boolean" | |
}, | |
"rgpd_date": { | |
"description": "Date au format YYYY-MM-DD de la qualification RGPD du contact ou de la qualification RGPD Partenaires du contact (obligatoire si rgpd = 1 ou rgpd_aff = 1)", | |
"type": "string" | |
}, | |
"rgpd_aff_notice": { | |
"description": "Texte du consentement", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/contacts/{id_contact}/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Données d'un contact", | |
"operationId": "api_v2_mail_contacts_show", | |
"parameters": [ | |
{ | |
"name": "id_contact", | |
"in": "path", | |
"description": "Identifiant du contact", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_contact": "1", | |
"prenom": "Learny", | |
"nom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"code_postal": "", | |
"ville": "", | |
"pays": "", | |
"tel": "", | |
"mobile": "", | |
"etat": "subscribed", | |
"rgpd": "0", | |
"date_inscription": "2019-03-15 12:01:06", | |
"sequences": [], | |
"tags": [], | |
"custom_fields": { | |
"tel": "", | |
"adresse": "", | |
"ville": "", | |
"code_postal": "", | |
"pays": "", | |
"tva": "", | |
"siret": "", | |
"paypal_account": "0", | |
"site_web": "", | |
"affilie_id_client": "1" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Suppression d'un contact", | |
"operationId": "api_v2_mail_contacts_delete", | |
"parameters": [ | |
{ | |
"name": "id_contact", | |
"in": "path", | |
"description": "Identifiant du contact", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/contacts/{id_contact}/{action}/": { | |
"post": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Ajouter un tag ou une séquence à un contact", | |
"operationId": "api_v2_mail_contacts_add_action", | |
"parameters": [ | |
{ | |
"name": "id_contact", | |
"in": "path", | |
"description": "Identifiant d'un contact", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "action", | |
"in": "path", | |
"description": "tag ou sequence", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"tag", | |
"sequence" | |
] | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b>Champs id obligatoire *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id": { | |
"description": "Identifiant d'un tag ou d'une séquence", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Retirer un tag ou une séquence d'un contact", | |
"operationId": "api_v2_mail_contacts_remove_action", | |
"parameters": [ | |
{ | |
"name": "id_contact", | |
"in": "path", | |
"description": "Identifiant d'un contact", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "action", | |
"in": "path", | |
"description": "tag ou sequence", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"tag", | |
"sequence" | |
] | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b>Champs id obligatoire *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id": { | |
"description": "Identifiant d'un tag ou d'une séquence", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/envois/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des envois", | |
"operationId": "api_v2_mail_envois_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_envoi": "1", | |
"id_sms": "0", | |
"sequences": "[1,2,3]", | |
"exclude_sequences": "[]", | |
"tags": "[]", | |
"exclude_tags": "[]", | |
"rgpd": "", | |
"etat": "processed", | |
"nb_envois": "0", | |
"nb_opens": "0", | |
"nb_bounces": "0", | |
"nb_complaints": "0", | |
"date": "2017-01-28 07:00:00", | |
"timezone": "Europe/Paris", | |
"date_timezone": "2017-01-28 07:00:00", | |
"date_envoi": "2017-01-28 07:00:00", | |
"mail": "Mail inconnu", | |
"destinataires": "3 séquences<br>" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/envois/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/envois/{id_envoi}/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Données d'un envoi", | |
"operationId": "api_v2_mail_envois_show", | |
"parameters": [ | |
{ | |
"name": "id_envoi", | |
"in": "path", | |
"description": "Identifiant de l'envoi", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_envoi": "1", | |
"id_sms": "0", | |
"sequences": "{1,2,3}", | |
"exclude_sequences": "{}", | |
"tags": "{}", | |
"exclude_tags": "{}", | |
"rgpd": "", | |
"etat": "processed", | |
"nb_envois": "0", | |
"nb_opens": "0", | |
"nb_bounces": "0", | |
"nb_complaints": "0", | |
"date": "2017-01-28 07:00:00", | |
"timezone": "Europe/Paris", | |
"date_timezone": "2017-01-28 07:00:00", | |
"date_envoi": "2017-01-28 07:00:00", | |
"mail": "Mail inconnu", | |
"destinataires": "3 séquences<br>" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/groupes/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des groupes", | |
"operationId": "api_v2_mail_groupes_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_groupe": 1, | |
"nom": "abc", | |
"description": "", | |
"date": "2017-11-27T13:07:00+0100", | |
"date_modification": "2017-11-28T13:07:00+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
}, | |
{ | |
"id_groupe": 2, | |
"nom": "clic", | |
"description": "", | |
"date": "2017-12-08T10:53:28+0100", | |
"date_modification": "2017-12-09T10:53:28+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/groupes/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/groupes/{id_groupe}/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Données d'un groupe", | |
"operationId": "api_v2_mail_groupes_show", | |
"parameters": [ | |
{ | |
"name": "id_groupe", | |
"in": "path", | |
"description": "Identifiant du groupe", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_groupe": 1, | |
"nom": "abc", | |
"description": "", | |
"date": "2017-11-27T13:07:00+0100", | |
"date_modification": "2017-11-28T13:07:00+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/sequences/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des séquences", | |
"operationId": "api_v2_mail_sequences_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_sequence": 1, | |
"version": 1, | |
"nom": "Découvrez mon cadeau gratuit", | |
"description": "", | |
"langue": "francais", | |
"optin": "simple", | |
"from_name": "Learnybox", | |
"from_email": "[email protected]", | |
"reply_to": "[email protected]", | |
"signature": "", | |
"sujet_inscription": "", | |
"mail_inscription": "", | |
"sujet_desinscription": "", | |
"mail_desinscription": "", | |
"reoptin": "", | |
"active": true, | |
"in_process": false, | |
"date_in_process": "" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/sequences/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/sequences/{id_sequence}/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Données d'une séquence", | |
"operationId": "api_v2_mail_sequences_show", | |
"parameters": [ | |
{ | |
"name": "id_sequence", | |
"in": "path", | |
"description": "Identifiant de la séquence", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_sequence": 1, | |
"version": 1, | |
"nom": "Découvrez mon cadeau gratuit", | |
"description": "", | |
"langue": "francais", | |
"optin": "simple", | |
"from_name": "Learnybox", | |
"from_email": "[email protected]", | |
"reply_to": "[email protected]", | |
"signature": "", | |
"sujet_inscription": "", | |
"mail_inscription": "", | |
"sujet_desinscription": "", | |
"mail_desinscription": "", | |
"reoptin": "", | |
"active": true, | |
"in_process": false, | |
"date_in_process": "" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/tags/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Liste des tags", | |
"operationId": "api_v2_mail_tags_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_tag": 1, | |
"nom": "abc", | |
"description": "", | |
"date": "2017-11-27T13:07:00+0100", | |
"date_modification": "2017-11-28T13:07:00+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
}, | |
{ | |
"id_tag": 2, | |
"nom": "clic", | |
"description": "", | |
"date": "2017-12-08T10:53:28+0100", | |
"date_modification": "2017-12-09T10:53:28+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/mail/tags/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/mail/tags/{id_tag}/": { | |
"get": { | |
"tags": [ | |
"Mail" | |
], | |
"summary": "Données d'un tag", | |
"operationId": "api_v2_mail_tags_show", | |
"parameters": [ | |
{ | |
"name": "id_tag", | |
"in": "path", | |
"description": "Identifiant du tag", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_tag": 1, | |
"nom": "abc", | |
"description": "", | |
"date": "2017-11-27T13:07:00+0100", | |
"date_modification": "2017-11-28T13:07:00+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/articles/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Liste des articles de votre site", | |
"operationId": "api_v2_site_articles_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_article": 1, | |
"titre": "La Nouvelle version de LearnyBox va vous changer la Vie...", | |
"permalink": "la-nouvelle-dimension-learnybox-v3", | |
"image": "", | |
"image_small": "", | |
"image_afficher": true, | |
"description_short": "LearnyBox vous invite à découvrir en avant-première la nouvelle dimension de LearnyBox V3. Elle va vous changer la vie...", | |
"article_html": "<p>azeazeaze</p>\\r\\n", | |
"additionnal_css": "", | |
"additionnal_js": "<script type='text/javascript'> </script>", | |
"link_demo": "", | |
"link_download": "", | |
"tags": "", | |
"publication": "encours", | |
"vues": 0, | |
"comments": true, | |
"display_share": true, | |
"display_author": true, | |
"display_related": true, | |
"seo_titre": "", | |
"seo_description": "", | |
"date": "2019-04-29T10:29:39+0200", | |
"date_creation": "2017-09-26T10:07:00+0200", | |
"date_publication": "2017-09-27T09:53:12+0200" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/site/articles/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Enregistrer un nouvel article", | |
"operationId": "api_v2_site_articles_create", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"titre": { | |
"description": "Titre", | |
"type": "string" | |
}, | |
"date_publication": { | |
"description": "Date de publication", | |
"type": "string" | |
}, | |
"seo_titre": { | |
"description": "Titre SEO", | |
"type": "string" | |
}, | |
"seo_description": { | |
"description": "Description SEO", | |
"type": "string" | |
}, | |
"article_html": { | |
"description": "Contenu de l'article en HTML", | |
"type": "string" | |
}, | |
"additionnal_js": { | |
"description": "Contenu javascript additionnel", | |
"type": "string" | |
}, | |
"id_categorie": { | |
"description": "ID de la catégorie", | |
"type": "integer" | |
}, | |
"user_id": { | |
"description": "ID de l'utilisateur", | |
"type": "integer" | |
}, | |
"additionnal_css": { | |
"description": "Contenu CSS additionnel", | |
"type": "string" | |
}, | |
"tags": { | |
"description": "Tags (séparés par une virgule)", | |
"type": "string" | |
}, | |
"description_short": { | |
"description": "Description courte", | |
"type": "string" | |
}, | |
"image": { | |
"description": "Image", | |
"type": "string" | |
}, | |
"image_afficher": { | |
"description": "0 pour ne pas afficher l'image / 1 pour afficher l'image", | |
"type": "boolean" | |
}, | |
"comments": { | |
"description": "0 pour ne pas autoriser les commentaires / 1 pour autoriser les commentaires", | |
"type": "boolean" | |
}, | |
"display_share": { | |
"description": "0 pour ne pas afficher les partages / 1 pour afficher les partages", | |
"type": "boolean" | |
}, | |
"display_author": { | |
"description": "0 pour ne pas afficher l'auteur / 1 pour afficher l'auteur", | |
"type": "boolean" | |
}, | |
"publication": { | |
"description": "valeurs autorisées : 'enattente', 'encours'", | |
"type": "string" | |
}, | |
"permalink": { | |
"description": "Lien parmanent de votre article", | |
"type": "string" | |
}, | |
"redirection_page": { | |
"description": "Page de redirection", | |
"type": "string" | |
}, | |
"redirection_url": { | |
"description": "URL de redirection", | |
"type": "string" | |
}, | |
"id_domaine": { | |
"description": "ID du domaine", | |
"type": "integer" | |
}, | |
"link_demo": { | |
"description": "URL de votre démo", | |
"type": "string" | |
}, | |
"link_download": { | |
"description": "URL de téléchargement", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Mise à jour d'un article", | |
"operationId": "api_v2_site_articles_edit", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"titre": { | |
"description": "Titre", | |
"type": "string" | |
}, | |
"date_publication": { | |
"description": "Date de publication", | |
"type": "string" | |
}, | |
"seo_titre": { | |
"description": "Titre SEO", | |
"type": "string" | |
}, | |
"seo_description": { | |
"description": "Description SEO", | |
"type": "string" | |
}, | |
"article_html": { | |
"description": "Contenu de l'article en HTML", | |
"type": "string" | |
}, | |
"additionnal_js": { | |
"description": "Contenu javascript additionnel", | |
"type": "string" | |
}, | |
"id_categorie": { | |
"description": "ID de la catégorie", | |
"type": "integer" | |
}, | |
"user_id": { | |
"description": "ID de l'utilisateur", | |
"type": "integer" | |
}, | |
"additionnal_css": { | |
"description": "Contenu CSS additionnel", | |
"type": "string" | |
}, | |
"tags": { | |
"description": "Tags (séparés par une virgule)", | |
"type": "string" | |
}, | |
"description_short": { | |
"description": "Description courte", | |
"type": "string" | |
}, | |
"image": { | |
"description": "Image", | |
"type": "string" | |
}, | |
"image_afficher": { | |
"description": "0 pour ne pas afficher l'image / 1 pour afficher l'image", | |
"type": "boolean" | |
}, | |
"comments": { | |
"description": "0 pour ne pas autoriser les commentaires / 1 pour autoriser les commentaires", | |
"type": "boolean" | |
}, | |
"display_share": { | |
"description": "0 pour ne pas afficher les partages / 1 pour afficher les partages", | |
"type": "boolean" | |
}, | |
"display_author": { | |
"description": "0 pour ne pas afficher l'auteur / 1 pour afficher l'auteur", | |
"type": "boolean" | |
}, | |
"publication": { | |
"description": "valeurs autorisées : 'enattente', 'encours'", | |
"type": "string" | |
}, | |
"permalink": { | |
"description": "Lien parmanent de votre article", | |
"type": "string" | |
}, | |
"redirection_page": { | |
"description": "Page de redirection", | |
"type": "string" | |
}, | |
"redirection_url": { | |
"description": "URL de redirection", | |
"type": "string" | |
}, | |
"id_domaine": { | |
"description": "ID du domaine", | |
"type": "integer" | |
}, | |
"link_demo": { | |
"description": "URL de votre démo", | |
"type": "string" | |
}, | |
"link_download": { | |
"description": "URL de téléchargement", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/articles/{id_article}/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Données d'un article", | |
"operationId": "api_v2_site_articles_show", | |
"parameters": [ | |
{ | |
"name": "id_article", | |
"in": "path", | |
"description": "Identifiant d'un article", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_article": 1, | |
"titre": "La Nouvelle version de LearnyBox va vous changer la Vie...", | |
"permalink": "la-nouvelle-dimension-learnybox-v3", | |
"image": "", | |
"image_small": "", | |
"image_afficher": true, | |
"description_short": "LearnyBox vous invite à découvrir en avant-première la nouvelle dimension de LearnyBox V3. Elle va vous changer la vie...", | |
"article_html": "<p>azeazeaze</p>\\r\\n", | |
"additionnal_css": "", | |
"additionnal_js": "<script type='text/javascript'> </script>", | |
"link_demo": "", | |
"link_download": "", | |
"tags": "", | |
"publication": "encours", | |
"vues": 0, | |
"comments": true, | |
"display_share": true, | |
"display_author": true, | |
"display_related": true, | |
"seo_titre": "", | |
"seo_description": "", | |
"date": "2019-04-29T10:29:39+0200", | |
"date_creation": "2017-09-26T10:07:00+0200", | |
"date_publication": "2017-09-27T09:53:12+0200" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Suppression d'un article", | |
"operationId": "api_v2_site_articles_delete", | |
"parameters": [ | |
{ | |
"name": "id_article", | |
"in": "path", | |
"description": "Identifiant d'un article", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/articles/{id_article}/comments/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Commentaires d'un article", | |
"operationId": "api_v2_site_articles_comments_list", | |
"parameters": [ | |
{ | |
"name": "id_article", | |
"in": "path", | |
"description": "Identifiant d'un article", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/articles/{id_article}/comments/{id_commentaire}/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Données d'un commentaire d'un article", | |
"operationId": "api_v2_site_articles_comments_show", | |
"parameters": [ | |
{ | |
"name": "id_article", | |
"in": "path", | |
"description": "Identifiant d'un article", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_commentaire": 1, | |
"prenom": "", | |
"email": "[email protected]", | |
"site": "", | |
"commentaire": "Lorem Ipsum", | |
"adresse": "", | |
"telephone": "", | |
"nom": "", | |
"etat": "approuve", | |
"notification": false, | |
"pays": "FR", | |
"date": "2017-01-19T14:18:32+0100", | |
"article": [], | |
"childs": [], | |
"user": [] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/articles/{id_article}/comments/{id_commentaire}/response/": { | |
"post": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Enregistrer un nouveau commentaire pour un article", | |
"operationId": "api_v2_site_articles_comments_response_create", | |
"parameters": [ | |
{ | |
"name": "id_article", | |
"in": "path", | |
"description": "Identifiant d'un article", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"user_id": { | |
"description": "Identifiant de l'utilisateur", | |
"type": "integer" | |
}, | |
"name": { | |
"description": "Nom de l'utilisateur", | |
"type": "integer" | |
}, | |
"email": { | |
"description": "Email de l'utilisateur", | |
"type": "integer" | |
}, | |
"id_article": { | |
"description": "Identifiant de l'article", | |
"type": "integer" | |
}, | |
"message": { | |
"description": "Message", | |
"type": "string" | |
}, | |
"orig_comment": { | |
"description": "Identifiant du commentaire d'origine", | |
"type": "integer" | |
}, | |
"notification_email": { | |
"description": "0 pour ne pas notifier / 1 pour notifier", | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/comments/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Liste des commentaires de votre site", | |
"operationId": "api_v2_site_comments_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_commentaire": 1, | |
"parent": 0, | |
"prenom": "", | |
"email": "[email protected]", | |
"site": "", | |
"commentaire": "Je voudrais savoir comment je peux créer un article comme celui-ci ?", | |
"adresse": "", | |
"telephone": "", | |
"nom": "", | |
"etat": "approuve", | |
"notification": false, | |
"pays": "FR", | |
"date": "2017-01-19T14:18:32+0100", | |
"article": { | |
"id_article": 3, | |
"titre": "Article 3", | |
"permalink": "article3", | |
"image": "", | |
"image_small": "", | |
"image_afficher": true, | |
"description_short": "There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable.", | |
"article_html": "<p class='title'>There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or raazendomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to <u><strong>be sure there isn'taze anything embarrassing hidden in the middle of text2</strong></u></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n\\r\\n<p><strong>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</strong></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n", | |
"additionnal_css": "", | |
"additionnal_js": "<script type='text/javascript'> </script>", | |
"link_demo": "", | |
"link_download": "", | |
"tags": "Android,iPhone,Jquery,PHP", | |
"publication": "encours", | |
"vues": 52, | |
"comments": true, | |
"display_share": false, | |
"display_author": true, | |
"display_related": true, | |
"seo_titre": "", | |
"seo_description": "", | |
"date": "2017-09-27T07:52:48+0200", | |
"date_creation": "2013-02-23T19:43:47+0100", | |
"date_publication": "2017-01-26T08:00:00+0100" | |
} | |
}, | |
{ | |
"id_commentaire": 2, | |
"parent": 0, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"site": "https://learnybox.com", | |
"commentaire": "Bravo pour cette présentation !", | |
"adresse": "", | |
"telephone": "", | |
"nom": "", | |
"etat": "approuve", | |
"notification": false, | |
"pays": "FR", | |
"date": "2017-01-19T14:17:41+0100", | |
"article": { | |
"id_article": 3, | |
"titre": "Article 3", | |
"permalink": "article3", | |
"image": "", | |
"image_small": "", | |
"image_afficher": true, | |
"description_short": "There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable.", | |
"article_html": "<p class='title'>There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or raazendomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to <u><strong>be sure there isn'taze anything embarrassing hidden in the middle of text2</strong></u></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n\\r\\n<p><strong>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</strong></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n", | |
"additionnal_css": "", | |
"additionnal_js": "<script type='text/javascript'> </script>", | |
"link_demo": "", | |
"link_download": "", | |
"tags": "Android,iPhone,Jquery,PHP", | |
"publication": "encours", | |
"vues": 52, | |
"comments": true, | |
"display_share": false, | |
"display_author": true, | |
"display_related": true, | |
"seo_titre": "", | |
"seo_description": "", | |
"date": "2017-09-27T07:52:48+0200", | |
"date_creation": "2013-02-23T19:43:47+0100", | |
"date_publication": "2017-01-26T08:00:00+0100" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/site/comments/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Enregistrer un nouveau commentaire", | |
"operationId": "api_v2_site_comments_create", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"pl": { | |
"description": "Permalink", | |
"type": "string" | |
}, | |
"message": { | |
"description": "Message", | |
"type": "string" | |
}, | |
"email": { | |
"description": "Email", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Prénom", | |
"type": "string" | |
}, | |
"nom": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"site": { | |
"description": "URL du site", | |
"type": "string" | |
}, | |
"adresse": { | |
"description": "Adresse", | |
"type": "string" | |
}, | |
"telephone": { | |
"description": "Téléphone", | |
"type": "integer" | |
}, | |
"notification": { | |
"description": "0 pour ne pas notifier / 1 pour notifier", | |
"type": "boolean" | |
}, | |
"comments": { | |
"description": "0 pour ne pas autoriser les commentaires / 1 pour autoriser les commentaires", | |
"type": "boolean" | |
}, | |
"orig_comment": { | |
"description": "0 pour ne pas afficher le commentaire d'origine / 1 pour afficher le commentaire d'origine", | |
"type": "boolean" | |
}, | |
"GEOIP_COUNTRY_CODE": { | |
"description": "Code pays", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Mise à jour d'un commentaire", | |
"operationId": "api_v2_site_comments_edit", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_commentaire": { | |
"description": "ID du commentaire", | |
"type": "integer" | |
}, | |
"message": { | |
"description": "Message", | |
"type": "string" | |
}, | |
"etat": { | |
"description": "État", | |
"type": "string" | |
}, | |
"site": { | |
"description": "URL du site", | |
"type": "string" | |
}, | |
"email": { | |
"description": "Email", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Prénom", | |
"type": "string" | |
}, | |
"nom": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"adresse": { | |
"description": "Adresse", | |
"type": "string" | |
}, | |
"telephone": { | |
"description": "Téléphone", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/comments/{id_comment}/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Données d'un commentaire", | |
"operationId": "api_v2_site_comments_show", | |
"parameters": [ | |
{ | |
"name": "id_comment", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_commentaire": 1, | |
"parent": 0, | |
"prenom": "", | |
"email": "[email protected]", | |
"site": "", | |
"commentaire": "Je voudrais savoir comment je peux créer un article comme celui-ci ?", | |
"adresse": "", | |
"telephone": "", | |
"nom": "", | |
"etat": "approuve", | |
"notification": false, | |
"pays": "FR", | |
"date": "2017-01-19T14:18:32+0100", | |
"article": { | |
"id_article": 3, | |
"titre": "Article 3", | |
"permalink": "article3", | |
"image": "", | |
"image_small": "", | |
"image_afficher": true, | |
"description_short": "There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable.", | |
"article_html": "<p class='title'>There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or raazendomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to <u><strong>be sure there isn'taze anything embarrassing hidden in the middle of text2</strong></u></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n\\r\\n<p><strong>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</strong></p>\\r\\n\\r\\n<p>Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.</p>\\r\\n", | |
"additionnal_css": "", | |
"additionnal_js": "<script type='text/javascript'> </script>", | |
"link_demo": "", | |
"link_download": "", | |
"tags": "Android,iPhone,Jquery,PHP", | |
"publication": "encours", | |
"vues": 52, | |
"comments": true, | |
"display_share": false, | |
"display_author": true, | |
"display_related": true, | |
"seo_titre": "", | |
"seo_description": "", | |
"date": "2017-09-27T07:52:48+0200", | |
"date_creation": "2013-02-23T19:43:47+0100", | |
"date_publication": "2017-01-26T08:00:00+0100" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Suppression d'un commentaire", | |
"operationId": "api_v2_site_comments_delete", | |
"parameters": [ | |
{ | |
"name": "id_comment", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/pages/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Liste des pages de votre site", | |
"operationId": "api_v2_site_pages_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_page": 1, | |
"version": 1, | |
"nom": "Accueil", | |
"permalink": "accueil", | |
"type": "compose", | |
"theme": "site-index", | |
"publiee": true, | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": 0, | |
"header": true, | |
"footer": true, | |
"display_header": true, | |
"display_footer": true, | |
"display_title": false, | |
"display_sidebar": false, | |
"display_menu": true, | |
"disable_indexation": false, | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#b2ce74','#7a8c9e','#526173'],'color_gray':'#a5a5a5','fonts':['Rubik'],'font_sizes':{'h1':{'font_size':'72','font_color':'#526173','font_family':'default'},'h2':{'font_size':'36','font_color':'#526173','font_family':'default'},'h3':{'font_size':'28','font_color':'#526173','font_family':'default'},'h4':{'font_size':'22','font_color':'#526173','font_family':'default'},'h5':{'font_size':'16','font_color':'#526173','font_family':'default'},'h6':{'font_size':'14','font_color':'#526173','font_family':'default'},'p':{'font_size':'14','font_color':'#526173','font_family':'default'},'small':{'font_size':'12','font_color':'#526173','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#f3f6f9','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#e9edf1','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#534d89','bgcolor2':'#6dbed7','angle':'315','opacity':'','opacity2':''},'4':{'bgcolor1':'#0d1d4a','bgcolor2':'#307892','angle':'135','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#b2ce74','bg_color2':'','color_text':'#ffffff','bg_color1_white':'','color_text_white':'','border_radius':'0'},'temoignages':{'color_icone':'#b2ce74','color_hr':'#b2ce74','color_txt':'#526173','color_user':'#526173','color_user_title':'#526173'}}", | |
"fonts": "", | |
"config": "", | |
"animations": "", | |
"vues": 0, | |
"thumbnail": "", | |
"editor_level": "expert", | |
"facebook_pixel_event": "", | |
"date_creation": "2019-03-15T12:01:04+0100", | |
"date_modification": "2019-03-15T12:01:04+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 1, | |
"total": 7, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/site/pages/?limit=100&offset=0", | |
"rel": "self" | |
}, | |
"next": { | |
"href": "https://api.learnybox.com/api/v2/site/pages/?id_page=2", | |
"rel": "next" | |
}, | |
"last": { | |
"rel": "last", | |
"href": "https://api.learnybox.com/api/v2/site/pages/?id_page=7" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Enregistrer une nouvelle page", | |
"operationId": "api_v2_site_pages_create", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"nom": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"seo_description": { | |
"description": "", | |
"type": "string" | |
}, | |
"seo_tags": { | |
"description": "", | |
"type": "string" | |
}, | |
"additionnal_css": { | |
"description": "", | |
"type": "string" | |
}, | |
"additionnal_js": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"permission": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"header": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"footer": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"display_title": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"display_sidebar": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"publiee": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"content": { | |
"description": "Contenu de l'article", | |
"type": "string" | |
}, | |
"permalink": { | |
"description": "Permalien", | |
"type": "string" | |
}, | |
"id_domaine": { | |
"description": "ID du domaine", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Mise à jour d'une page", | |
"operationId": "api_v2_site_pages_edit", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"nom": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"seo_description": { | |
"description": "", | |
"type": "string" | |
}, | |
"seo_tags": { | |
"description": "", | |
"type": "string" | |
}, | |
"additionnal_css": { | |
"description": "", | |
"type": "string" | |
}, | |
"additionnal_js": { | |
"description": "Nom", | |
"type": "string" | |
}, | |
"permission": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"header": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"footer": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"display_title": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"display_sidebar": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"publiee": { | |
"description": "0 / 1 ", | |
"type": "boolean" | |
}, | |
"content": { | |
"description": "Contenu de l'article", | |
"type": "string" | |
}, | |
"permalink": { | |
"description": "Permalien", | |
"type": "string" | |
}, | |
"id_domaine": { | |
"description": "ID du domaine", | |
"type": "integer" | |
}, | |
"file": { | |
"description": "", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/pages/{id_page}/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Données d'une page de votre site", | |
"operationId": "api_v2_site_pages_show", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_page": "1", | |
"id_client": "1", | |
"id_domaine": "0", | |
"version": "1", | |
"nom": "Accueil", | |
"permalink": "accueil", | |
"type": "compose", | |
"id_master_theme": "1", | |
"id_theme": "1", | |
"theme": "site-index", | |
"publiee": "1", | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": "0", | |
"header": "1", | |
"footer": "1", | |
"display_header": "1", | |
"display_footer": "1", | |
"display_title": "0", | |
"display_sidebar": "0", | |
"display_menu": "1", | |
"disable_indexation": "0", | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#b2ce74','#7a8c9e','#526173'],'color_gray':'#a5a5a5','fonts':['Rubik'],'font_sizes':{'h1':{'font_size':'72','font_color':'#526173','font_family':'default'},'h2':{'font_size':'36','font_color':'#526173','font_family':'default'},'h3':{'font_size':'28','font_color':'#526173','font_family':'default'},'h4':{'font_size':'22','font_color':'#526173','font_family':'default'},'h5':{'font_size':'16','font_color':'#526173','font_family':'default'},'h6':{'font_size':'14','font_color':'#526173','font_family':'default'},'p':{'font_size':'14','font_color':'#526173','font_family':'default'},'small':{'font_size':'12','font_color':'#526173','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#f3f6f9','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#e9edf1','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#534d89','bgcolor2':'#6dbed7','angle':'315','opacity':'','opacity2':''},'4':{'bgcolor1':'#0d1d4a','bgcolor2':'#307892','angle':'135','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#b2ce74','bg_color2':'','color_text':'#ffffff','bg_color1_white':'','color_text_white':'','border_radius':'0'},'temoignages':{'color_icone':'#b2ce74','color_hr':'#b2ce74','color_txt':'#526173','color_user':'#526173','color_user_title':'#526173'}}", | |
"fonts": "", | |
"config": "", | |
"animations": "", | |
"vues": "0", | |
"thumbnail": "", | |
"editor_level": "expert", | |
"google_analytics_id": "0", | |
"facebook_pixel_event": "", | |
"facebook_pixel_id": "0", | |
"date_creation": "2019-03-15 12:01:04", | |
"date_modification": "2019-03-15 12:01:04" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Suppression d'une page", | |
"operationId": "api_v2_site_pages_delete", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/pages/{id_page}/comments/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Commentaires d'une page", | |
"operationId": "api_v2_site_pages_comments_list", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/pages/{id_page}/comments/{id_commentaire}/": { | |
"get": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Données d'un commentaire d'une page", | |
"operationId": "api_v2_site_pages_comments_show", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_commentaire": 1, | |
"prenom": "", | |
"email": "[email protected]", | |
"nom": "", | |
"site": "", | |
"commentaire": "Lorem Ipsum", | |
"adresse": "", | |
"telephone": "", | |
"etat": "approuve", | |
"notification": false, | |
"pays": "FR", | |
"date": "2017-01-19T14:18:32+0100", | |
"page": [], | |
"childs": [], | |
"user": [] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/pages/{id_page}/comments/{id_commentaire}/response/": { | |
"post": { | |
"tags": [ | |
"Site" | |
], | |
"summary": "Enregistrer un nouveau commentaire pour une page", | |
"operationId": "api_v2_site_pages_comments_response_create", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_commentaire", | |
"in": "path", | |
"description": "Identifiant d'un commentaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"user_id": { | |
"description": "Identifiant de l'utilisateur", | |
"type": "integer" | |
}, | |
"name": { | |
"description": "Nom de l'utilisateur", | |
"type": "integer" | |
}, | |
"email": { | |
"description": "Email de l'utilisateur", | |
"type": "integer" | |
}, | |
"pl": { | |
"description": "Permalink de la page", | |
"type": "integer" | |
}, | |
"message": { | |
"description": "Message", | |
"type": "string" | |
}, | |
"orig_comment": { | |
"description": "Identifiant du commentaire d'origine", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/support/": { | |
"get": { | |
"tags": [ | |
"Support" | |
], | |
"summary": "Liste des tickets de votre support en ligne", | |
"operationId": "api_v2_support_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/support/{id_ticket}/": { | |
"delete": { | |
"tags": [ | |
"Support" | |
], | |
"summary": "Suppression d'un ticket", | |
"operationId": "api_v2_support_delete", | |
"parameters": [ | |
{ | |
"name": "id_ticket", | |
"in": "path", | |
"description": "Identifiant du ticket", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/messages/": { | |
"get": { | |
"tags": [ | |
"Messages" | |
], | |
"summary": "Liste des messages postés sur votre formulaire de contact", | |
"operationId": "api_v2_messages_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"reponse": 0, | |
"type": "question", | |
"priorite": "Basse", | |
"nom": "Box1", | |
"prenom": "Learny", | |
"email": "test1@learnybox", | |
"message": "test message", | |
"lu": true, | |
"date": "2018-01-15T15:07:05+0100" | |
}, | |
{ | |
"reponse": 0, | |
"type": "question", | |
"priorite": "Basse", | |
"nom": "Box2", | |
"prenom": "Learny", | |
"email": "test2@learnybox", | |
"message": "test message", | |
"lu": true, | |
"date": "2018-01-15T15:07:05+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/messages/{id_message}/": { | |
"delete": { | |
"tags": [ | |
"Messages" | |
], | |
"summary": "Supprimer un message posté depuis votre formulaire de contact", | |
"operationId": "api_v2_messages_delete", | |
"parameters": [ | |
{ | |
"name": "id_message", | |
"in": "path", | |
"description": "Identifiant du message", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/support/tickets/": { | |
"get": { | |
"tags": [ | |
"Support" | |
], | |
"summary": "Tickets/Liste des tickets de votre support en ligne", | |
"operationId": "api_v2_support_tickets_list", | |
"responses": { | |
"200": { | |
"description": "" | |
}, | |
"default": { | |
"description": "an \"unexpected\" error" | |
} | |
} | |
} | |
}, | |
"/api/v2/support/tickets/{ticketid}/": { | |
"delete": { | |
"tags": [ | |
"Support" | |
], | |
"summary": "Tickets/Suppression d'un ticket", | |
"operationId": "api_v2_support_tickets_delete", | |
"parameters": [ | |
{ | |
"name": "ticketid", | |
"in": "path", | |
"description": "Identifiant du ticket", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "" | |
}, | |
"default": { | |
"description": "an \"unexpected\" error" | |
} | |
} | |
} | |
}, | |
"/api/v2/transactions/": { | |
"get": { | |
"tags": [ | |
"Transactions" | |
], | |
"summary": "Liste des transactions", | |
"operationId": "api_v2_transactions_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 1, | |
"valid": true, | |
"etat": "ok", | |
"type": "cheque", | |
"montant_ht": 10, | |
"display_montant_ht": "€10", | |
"tva": 20, | |
"montant": 12, | |
"display_montant": "€12", | |
"devise": "EUR", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"descriptor": "LearnyStart", | |
"ip": "127.0.0.1", | |
"date": "2019-03-18T16:47:26+0100", | |
"date_valid": "2019-03-18T16:48:11+0100", | |
"client": { | |
"nom_client": "Learny Box1" | |
}, | |
"id_trans": "TEST0001", | |
"shop_customer": { | |
"id_customer": 1, | |
"datas": { | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"cp": "", | |
"ville": "", | |
"pays": "FR", | |
"telephone": "0123456789", | |
"societe": "LearnyBox", | |
"tva_intracom": "", | |
"site": "https://learnybox.com", | |
"uniqid": "1" | |
} | |
}, | |
"transaction_produits": [ | |
{ | |
"id_transaction_produit": 1, | |
"quantite": 1, | |
"nom": "Produit", | |
"montant_ht": 10, | |
"display_montant_ht": 10, | |
"tva": 20, | |
"montant_ttc": 12, | |
"display_montant_ttc": 12, | |
"devise": "EUR", | |
"date": "2019-03-18T16:47:26+0100" | |
} | |
] | |
}, | |
{ | |
"id": 2, | |
"valid": true, | |
"etat": "ok", | |
"type": "cheque", | |
"montant_ht": 10, | |
"tva": 20, | |
"montant": 12, | |
"devise": "EUR", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"descriptor": "LearnyStart", | |
"ip": "127.0.0.1", | |
"date": "2019-03-18T16:47:26+0100", | |
"date_valid": "2019-03-18T16:48:11+0100", | |
"client": { | |
"nom_client": "Learny Box2" | |
}, | |
"id_trans": "TEST0002", | |
"shop_customer": { | |
"id_customer": 1, | |
"datas": { | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"cp": "", | |
"ville": "", | |
"pays": "FR", | |
"telephone": "0123456789", | |
"societe": "LearnyBox", | |
"tva_intracom": "", | |
"site": "https://learnybox.com", | |
"uniqid": "1" | |
} | |
}, | |
"transaction_produits": [ | |
{ | |
"id_transaction_produit": 1, | |
"quantite": 1, | |
"nom": "Produit", | |
"montant_ht": 10, | |
"display_montant_ht": 10, | |
"tva": 20, | |
"montant_ttc": 12, | |
"display_montant_ttc": 12, | |
"devise": "EUR", | |
"date": "2019-03-18T16:47:26+0100" | |
} | |
] | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/transactions/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Transactions" | |
], | |
"summary": "Ajouter une nouvelle transaction", | |
"operationId": "api_v2_transactions_create", | |
"requestBody": { | |
"description": "<b>Champs nom, prenom et email obligatoires *</b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_transaction": { | |
"description": "Numéro de transaction", | |
"type": "string" | |
}, | |
"produit": { | |
"description": "Nom du produit", | |
"type": "string" | |
}, | |
"prenom": { | |
"description": "Prénom du client", | |
"type": "string" | |
}, | |
"nom": { | |
"description": "Nom du client", | |
"type": "string" | |
}, | |
"email": { | |
"description": "Adresse email du client", | |
"type": "string" | |
}, | |
"montant_ht": { | |
"description": "Montant HT", | |
"type": "string" | |
}, | |
"tva": { | |
"description": "Taux de TVA", | |
"type": "string" | |
}, | |
"montant_ttc": { | |
"description": "Montant TTC", | |
"type": "string" | |
}, | |
"devise": { | |
"description": "EUR, CAD, USD, GPB, etc.", | |
"type": "string" | |
}, | |
"mode_paiement": { | |
"description": "Paypal, Stripe, chèque, etc.", | |
"type": "string" | |
}, | |
"etat": { | |
"description": "Valeurs possibles pour ce champs : valide / enattente / delivering (en cours de livraison) / delivered (livrée) / cancel (annulée) / error / refunded", | |
"type": "string", | |
"enum": [ | |
"valide", | |
"enattente", | |
"delivering", | |
"delivered", | |
"cancel", | |
"error", | |
"refunded" | |
] | |
}, | |
"date": { | |
"description": "Date (format YYYY-MM-DD HH:II:SS)", | |
"type": "string" | |
}, | |
"id_formation": { | |
"description": "Identifiant de la formation", | |
"type": "string" | |
}, | |
"groupes": { | |
"description": "ID des groupes séparés par une virgule", | |
"type": "string" | |
}, | |
"nb_credits": { | |
"description": "Nombre de crédits à ajouter au membre", | |
"type": "integer" | |
}, | |
"adresse": { | |
"description": "Adresse du membre", | |
"type": "string" | |
}, | |
"ville": { | |
"description": "Ville du membre", | |
"type": "string" | |
}, | |
"pays": { | |
"description": "Pays du membre", | |
"type": "string" | |
}, | |
"code_postal": { | |
"description": "Code postal du membre", | |
"type": "string" | |
}, | |
"tel": { | |
"description": "Numéro de téléphone du membre", | |
"type": "string" | |
}, | |
"id_campaign": { | |
"description": "Identifiant de campagne d'affiliation", | |
"type": "integer" | |
}, | |
"id_affilie": { | |
"description": "Identifiant de l'affilié", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/transactions/user/{user_id}/": { | |
"get": { | |
"tags": [ | |
"Transactions" | |
], | |
"summary": "Liste des transactions", | |
"operationId": "api_v2_transactions_user_list", | |
"parameters": [ | |
{ | |
"name": "user_id", | |
"in": "path", | |
"description": "Identifiant du membre dans LearnyBox", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id": 1, | |
"valid": true, | |
"etat": "ok", | |
"type": "cheque", | |
"montant_ht": 10, | |
"display_montant_ht": "€12", | |
"tva": 20, | |
"montant": 12, | |
"devise": "EUR", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"descriptor": "LearnyStart", | |
"ip": "127.0.0.1", | |
"date": "2019-03-18T16:47:26+0100", | |
"date_valid": "2019-03-18T16:48:11+0100", | |
"client": { | |
"nom_client": "Learny Box1" | |
}, | |
"id_trans": "TEST0001", | |
"shop_customer": { | |
"id_customer": 1, | |
"datas": { | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"cp": "", | |
"ville": "", | |
"pays": "FR", | |
"telephone": "0123456789", | |
"societe": "LearnyBox", | |
"tva_intracom": "", | |
"site": "https://learnybox.com", | |
"uniqid": "1" | |
} | |
} | |
}, | |
{ | |
"id": 2, | |
"valid": true, | |
"etat": "ok", | |
"type": "cheque", | |
"montant_ht": 10, | |
"display_montant_ht": "€10", | |
"tva": 20, | |
"montant": 12, | |
"display_montant": "€12", | |
"devise": "EUR", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"descriptor": "LearnyStart", | |
"ip": "127.0.0.1", | |
"date": "2019-03-18T16:47:26+0100", | |
"date_valid": "2019-03-18T16:48:11+0100", | |
"client": { | |
"nom_client": "Learny Box1" | |
}, | |
"id_trans": "TEST0002", | |
"shop_customer": { | |
"id_customer": 1, | |
"datas": { | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"cp": "", | |
"ville": "", | |
"pays": "FR", | |
"telephone": "0123456789", | |
"societe": "LearnyBox", | |
"tva_intracom": "", | |
"site": "https://learnybox.com", | |
"uniqid": "1" | |
} | |
}, | |
"transaction_produits": [ | |
{ | |
"id_transaction_produit": 1, | |
"quantite": 1, | |
"nom": "Produit", | |
"montant_ht": 10, | |
"display_montant_ht": 10, | |
"tva": 20, | |
"montant_ttc": 12, | |
"display_montant_ttc": 12, | |
"devise": "EUR", | |
"date": "2019-03-18T16:47:26+0100" | |
} | |
] | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/transactions/user/1/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/transactions/{id_trans}/": { | |
"get": { | |
"tags": [ | |
"Transactions" | |
], | |
"summary": "Données d'une transaction", | |
"operationId": "api_v2_transactions_show", | |
"parameters": [ | |
{ | |
"name": "id_trans", | |
"in": "path", | |
"description": "Identifiant d'une transaction", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id": 1, | |
"valid": true, | |
"etat": "ok", | |
"type": "cheque", | |
"montant_ht": 10, | |
"tva": 20, | |
"montant": 12, | |
"devise": "EUR", | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"descriptor": "LearnyStart", | |
"ip": "127.0.0.1", | |
"date": "2019-03-18T16:47:26+0100", | |
"date_valid": "2019-03-18T16:48:11+0100", | |
"client": { | |
"nom_client": "Learny Box1" | |
}, | |
"id_trans": "TEST0001", | |
"shop_customer": { | |
"id_customer": 1, | |
"datas": { | |
"nom": "Learny", | |
"prenom": "Box", | |
"email": "[email protected]", | |
"adresse": "", | |
"cp": "", | |
"ville": "", | |
"pays": "FR", | |
"telephone": "0123456789", | |
"societe": "LearnyBox", | |
"tva_intracom": "", | |
"site": "https://learnybox.com", | |
"uniqid": "1" | |
} | |
}, | |
"transaction_produits": [ | |
{ | |
"id_transaction_produit": 1, | |
"quantite": 1, | |
"nom": "Produit", | |
"montant_ht": 10, | |
"display_montant_ht": 10, | |
"tva": 20, | |
"montant_ttc": 12, | |
"display_montant_ttc": 12, | |
"devise": "EUR", | |
"date": "2019-03-18T16:47:26+0100" | |
} | |
] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/tunnels/": { | |
"get": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Liste des tunnels", | |
"operationId": "api_v2_tunnels_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_tunnel": 1, | |
"nom": "Partir de zéro", | |
"permalink": "partir-de-zero", | |
"version": 1, | |
"sequence": "", | |
"redirection": "", | |
"publication": "encours", | |
"thumbnail": "", | |
"comment_users": "", | |
"date": "2017-12-19T09:36:03+0100", | |
"date_creation": "2017-12-19T09:36:03+0100", | |
"date_publication": "2017-12-24T16:21:31+0100", | |
"date_fin": "2017-12-24T16:21:28+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
}, | |
"tunnel_pages": [ | |
{ | |
"id_page": 9440, | |
"conf_type": "", | |
"version": 2, | |
"nom": "test capture 1", | |
"permalink": "test-capture-1", | |
"type": "optin", | |
"seo_description": "", | |
"seo_tags": "", | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": 0, | |
"display_header": false, | |
"display_footer": false, | |
"position": 1, | |
"publication": "encours", | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#4a90e2','#6d76b5','#575e66'],'color_gray':'#a5a5a5','fonts':['Lato'],'font_sizes':{'h1':{'font_size':'72','font_color':'#575e66','font_family':'default'},'h2':{'font_size':'36','font_color':'#575e66','font_family':'default'},'h3':{'font_size':'28','font_color':'#575e66','font_family':'default'},'h4':{'font_size':'22','font_color':'#575e66','font_family':'default'},'h5':{'font_size':'16','font_color':'#575e66','font_family':'default'},'h6':{'font_size':'14','font_color':'#575e66','font_family':'default'},'p':{'font_size':'14','font_color':'#575e66','font_family':'default'},'small':{'font_size':'12','font_color':'#575e66','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#fafafa','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#f2f2f2','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#989eb3','bgcolor2':'#8f9fb3','angle':'180','opacity':'','opacity2':''},'4':{'bgcolor1':'#2b2d33','bgcolor2':'#292e33','angle':'180','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#4a90e2','bg_color2':'','color_text':'#ffffff','bg_color1_white':'#ffffff','color_text_white':'#4a90e2','border_radius':'0'},'temoignages':{'color_icone':'#4a90e2','color_hr':'#4a90e2','color_txt':'#575e66','color_user':'#575e66','color_user_title':'#575e66'}}", | |
"animations": "", | |
"fonts": "", | |
"config": "", | |
"theme": "capture-grande-image", | |
"editor_level": "expert", | |
"disable_indexation": false, | |
"vues": 0, | |
"thumbnail": "", | |
"ligne": 1, | |
"colonne": 1, | |
"facebook_pixel_event": "0", | |
"date_creation": "2019-04-25T11:33:57+0200", | |
"date_modification": "-0001-11-30T00:00:00+0009" | |
} | |
] | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/tunnels/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/tunnels/{id_tunnel}/": { | |
"get": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Données d'un tunnel", | |
"operationId": "api_v2_tunnels_show", | |
"parameters": [ | |
{ | |
"name": "id_tunnel", | |
"in": "path", | |
"description": "Identifiant du tunnel", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_tunnel": 1, | |
"nom": "Partir de zéro", | |
"permalink": "partir-de-zero", | |
"version": 1, | |
"sequence": "", | |
"redirection": "", | |
"publication": "encours", | |
"thumbnail": "", | |
"comment_users": "", | |
"date": "2017-12-19T09:36:03+0100", | |
"date_creation": "2017-12-19T09:36:03+0100", | |
"date_publication": "2017-12-24T16:21:31+0100", | |
"date_fin": "2017-12-24T16:21:28+0100", | |
"client": { | |
"nom_client": "Learny Box" | |
}, | |
"tunnel_pages": [ | |
{ | |
"id_page": 9440, | |
"conf_type": "", | |
"version": 2, | |
"nom": "test capture 1", | |
"permalink": "test-capture-1", | |
"type": "optin", | |
"seo_description": "", | |
"seo_tags": "", | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": 0, | |
"display_header": false, | |
"display_footer": false, | |
"position": 1, | |
"publication": "encours", | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#4a90e2','#6d76b5','#575e66'],'color_gray':'#a5a5a5','fonts':['Lato'],'font_sizes':{'h1':{'font_size':'72','font_color':'#575e66','font_family':'default'},'h2':{'font_size':'36','font_color':'#575e66','font_family':'default'},'h3':{'font_size':'28','font_color':'#575e66','font_family':'default'},'h4':{'font_size':'22','font_color':'#575e66','font_family':'default'},'h5':{'font_size':'16','font_color':'#575e66','font_family':'default'},'h6':{'font_size':'14','font_color':'#575e66','font_family':'default'},'p':{'font_size':'14','font_color':'#575e66','font_family':'default'},'small':{'font_size':'12','font_color':'#575e66','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#fafafa','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#f2f2f2','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#989eb3','bgcolor2':'#8f9fb3','angle':'180','opacity':'','opacity2':''},'4':{'bgcolor1':'#2b2d33','bgcolor2':'#292e33','angle':'180','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#4a90e2','bg_color2':'','color_text':'#ffffff','bg_color1_white':'#ffffff','color_text_white':'#4a90e2','border_radius':'0'},'temoignages':{'color_icone':'#4a90e2','color_hr':'#4a90e2','color_txt':'#575e66','color_user':'#575e66','color_user_title':'#575e66'}}", | |
"animations": "", | |
"fonts": "", | |
"config": "", | |
"theme": "capture-grande-image", | |
"editor_level": "expert", | |
"disable_indexation": false, | |
"vues": 0, | |
"thumbnail": "", | |
"ligne": 1, | |
"colonne": 1, | |
"facebook_pixel_event": "0", | |
"date_creation": "2019-04-25T11:33:57+0200", | |
"date_modification": "-0001-11-30T00:00:00+0009" | |
} | |
] | |
}, | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/tunnels/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Suppression d'un tunnel", | |
"operationId": "api_v2_tunnels_delete", | |
"parameters": [ | |
{ | |
"name": "id_tunnel", | |
"in": "path", | |
"description": "Identifiant d'un tunnel", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/site/tunnels/": { | |
"post": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Enregistrer un nouveau tunnel", | |
"operationId": "api_v2_tunnels_create", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"nom": { | |
"description": "", | |
"type": "string" | |
}, | |
"sequence": { | |
"description": "", | |
"type": "string" | |
}, | |
"publication": { | |
"description": "", | |
"type": "string" | |
}, | |
"id_conference": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_webinaire": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_domaine": { | |
"description": "", | |
"type": "integer" | |
}, | |
"version": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_master_theme": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_theme": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_categorie": { | |
"description": "", | |
"type": "integer" | |
}, | |
"users": { | |
"description": "", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Mise à jour d'un tunnel", | |
"operationId": "api_v2_tunnels_edit", | |
"requestBody": { | |
"description": "<b></b>", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_tunnel": { | |
"description": "", | |
"type": "integer" | |
}, | |
"nom": { | |
"description": "", | |
"type": "string" | |
}, | |
"id_domaine": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_categorie": { | |
"description": "", | |
"type": "integer" | |
}, | |
"users": { | |
"description": "", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/tunnels/{id_tunnel}/pages/": { | |
"get": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Liste des pages d'un tunnel", | |
"operationId": "api_v2_tunnels_pages_list", | |
"parameters": [ | |
{ | |
"name": "id_tunnel", | |
"in": "path", | |
"description": "Identifiant d'un tunnel", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_page": 1, | |
"conf_type": "", | |
"version": 1, | |
"nom": "test capture 1", | |
"permalink": "test-capture-1", | |
"type": "optin", | |
"seo_description": "", | |
"seo_tags": "", | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": 0, | |
"display_header": false, | |
"display_footer": false, | |
"position": 1, | |
"publication": "encours", | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#4a90e2','#6d76b5','#575e66'],'color_gray':'#a5a5a5','fonts':['Lato'],'font_sizes':{'h1':{'font_size':'72','font_color':'#575e66','font_family':'default'},'h2':{'font_size':'36','font_color':'#575e66','font_family':'default'},'h3':{'font_size':'28','font_color':'#575e66','font_family':'default'},'h4':{'font_size':'22','font_color':'#575e66','font_family':'default'},'h5':{'font_size':'16','font_color':'#575e66','font_family':'default'},'h6':{'font_size':'14','font_color':'#575e66','font_family':'default'},'p':{'font_size':'14','font_color':'#575e66','font_family':'default'},'small':{'font_size':'12','font_color':'#575e66','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#fafafa','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#f2f2f2','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#989eb3','bgcolor2':'#8f9fb3','angle':'180','opacity':'','opacity2':''},'4':{'bgcolor1':'#2b2d33','bgcolor2':'#292e33','angle':'180','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#4a90e2','bg_color2':'','color_text':'#ffffff','bg_color1_white':'#ffffff','color_text_white':'#4a90e2','border_radius':'0'},'temoignages':{'color_icone':'#4a90e2','color_hr':'#4a90e2','color_txt':'#575e66','color_user':'#575e66','color_user_title':'#575e66'}}", | |
"animations": "", | |
"fonts": "", | |
"config": "", | |
"theme": "capture-grande-image", | |
"editor_level": "expert", | |
"vues": 0, | |
"thumbnail": "", | |
"facebook_pixel_event": "0", | |
"date_creation": "2019-04-25T11:33:57+0200" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/tunnels/2100/pages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Ajouter une page à un tunnel", | |
"operationId": "api_v2_tunnels_pages_create", | |
"parameters": [ | |
{ | |
"name": "id_tunnel", | |
"in": "path", | |
"description": "Identifiant d'un tunnel", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_tunnel": { | |
"description": "Identifiant d'un tunnel", | |
"type": "integer" | |
}, | |
"nom": { | |
"description": "", | |
"type": "string" | |
}, | |
"type": { | |
"description": "", | |
"type": "string" | |
}, | |
"position": { | |
"description": "", | |
"type": "integer" | |
}, | |
"permalink": { | |
"description": "", | |
"type": "string" | |
}, | |
"theme": { | |
"description": "", | |
"type": "string" | |
}, | |
"editor_level": { | |
"description": "", | |
"type": "string" | |
}, | |
"id_conference": { | |
"description": "", | |
"type": "integer" | |
}, | |
"conf_type": { | |
"description": "", | |
"type": "string" | |
}, | |
"id_webinaire": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_master_theme": { | |
"description": "", | |
"type": "integer" | |
}, | |
"id_theme": { | |
"description": "", | |
"type": "integer" | |
}, | |
"google_analytics": { | |
"description": "", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/tunnels/{id_tunnel}/pages/{id_page}/": { | |
"get": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Données d'une page d'un tunnel", | |
"operationId": "api_v2_tunnels_pages_show", | |
"parameters": [ | |
{ | |
"name": "id_tunnel", | |
"in": "path", | |
"description": "Identifiant d'un tunnel", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_page": 1, | |
"conf_type": "", | |
"version": 1, | |
"nom": "test capture 1", | |
"permalink": "test-capture-1", | |
"type": "optin", | |
"seo_description": "", | |
"seo_tags": "", | |
"seo_image": "", | |
"additionnal_css": "", | |
"additionnal_js": "", | |
"additionnal_js_head": "", | |
"permission": 0, | |
"display_header": false, | |
"display_footer": false, | |
"position": 1, | |
"publication": "encours", | |
"design": "{'bgcolor1':'','bgcolor2':'','gradient_angle':'0','colors':['#4a90e2','#6d76b5','#575e66'],'color_gray':'#a5a5a5','fonts':['Lato'],'font_sizes':{'h1':{'font_size':'72','font_color':'#575e66','font_family':'default'},'h2':{'font_size':'36','font_color':'#575e66','font_family':'default'},'h3':{'font_size':'28','font_color':'#575e66','font_family':'default'},'h4':{'font_size':'22','font_color':'#575e66','font_family':'default'},'h5':{'font_size':'16','font_color':'#575e66','font_family':'default'},'h6':{'font_size':'14','font_color':'#575e66','font_family':'default'},'p':{'font_size':'14','font_color':'#575e66','font_family':'default'},'small':{'font_size':'12','font_color':'#575e66','font_family':'default'}},'line_themes':{'1':{'bgcolor1':'#fafafa','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'2':{'bgcolor1':'#f2f2f2','bgcolor2':'','angle':'0','opacity':'','opacity2':''},'3':{'bgcolor1':'#989eb3','bgcolor2':'#8f9fb3','angle':'180','opacity':'','opacity2':''},'4':{'bgcolor1':'#2b2d33','bgcolor2':'#292e33','angle':'180','opacity':'0.75','opacity2':'0.75'}},'btn':{'bg_color1':'#4a90e2','bg_color2':'','color_text':'#ffffff','bg_color1_white':'#ffffff','color_text_white':'#4a90e2','border_radius':'0'},'temoignages':{'color_icone':'#4a90e2','color_hr':'#4a90e2','color_txt':'#575e66','color_user':'#575e66','color_user_title':'#575e66'}}", | |
"animations": "", | |
"fonts": "", | |
"config": "", | |
"theme": "capture-grande-image", | |
"editor_level": "expert", | |
"vues": 0, | |
"thumbnail": "", | |
"facebook_pixel_event": "0", | |
"date_creation": "2019-04-25T11:33:57+0200" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/tunnels/pages/{id_page}/": { | |
"delete": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Suppression d'une page", | |
"operationId": "api_v2_tunnels_pages_delete", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"patch": { | |
"tags": [ | |
"Tunnels" | |
], | |
"summary": "Mise à jour d'une page d'un tunnel", | |
"operationId": "api_v2_tunnels_pages_edit", | |
"parameters": [ | |
{ | |
"name": "id_page", | |
"in": "path", | |
"description": "Identifiant d'une page", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"description": "", | |
"required": true, | |
"content": { | |
"application/x-www-form-urlencoded;charset=UTF-8": { | |
"schema": { | |
"properties": { | |
"id_page": { | |
"description": "Identifiant d'un tunnel", | |
"type": "integer" | |
}, | |
"nom": { | |
"description": "", | |
"type": "string" | |
}, | |
"type": { | |
"description": "", | |
"type": "string" | |
}, | |
"publication": { | |
"description": "", | |
"type": "string" | |
}, | |
"permalink": { | |
"description": "", | |
"type": "string" | |
}, | |
"permission": { | |
"description": "", | |
"type": "boolean" | |
}, | |
"disable_indexation": { | |
"description": "", | |
"type": "boolean" | |
}, | |
"seo_description": { | |
"description": "", | |
"type": "string" | |
}, | |
"seo_tags": { | |
"description": "", | |
"type": "string" | |
}, | |
"seo_image": { | |
"description": "", | |
"type": "string" | |
}, | |
"editor_level": { | |
"description": "", | |
"type": "string" | |
}, | |
"facebook_pixel": { | |
"description": "", | |
"type": "boolean" | |
}, | |
"facebook_pixel_id": { | |
"description": "", | |
"type": "integer" | |
}, | |
"facebook_pixel_event": { | |
"description": "", | |
"type": "string" | |
}, | |
"google_analytics": { | |
"description": "", | |
"type": "boolean" | |
}, | |
"google_analytics_id": { | |
"description": "", | |
"type": "integer" | |
}, | |
"google_optimize_id": { | |
"description": "", | |
"type": "string" | |
}, | |
"ligne": { | |
"description": "", | |
"type": "integer" | |
}, | |
"colonne": { | |
"description": "", | |
"type": "integer" | |
} | |
}, | |
"type": "object" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/users/{id_user}/": { | |
"get": { | |
"tags": [ | |
"Utilisateurs" | |
], | |
"summary": "Données d'un utilisateur", | |
"operationId": "api_v2_users_show", | |
"parameters": [ | |
{ | |
"name": "id_user", | |
"in": "path", | |
"description": "Identifiant de l'utilisateur", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"user_id": 1, | |
"validated": 1, | |
"contact_technique": 0, | |
"fname": "Learny", | |
"lname": "Box2", | |
"email": "[email protected]", | |
"newsletter": true, | |
"rgpd": false, | |
"rgpd_aff": false, | |
"user_configs": { | |
"pseudo": { | |
"id": 17053, | |
"name": "pseudo", | |
"value": "", | |
"date": "2019-04-23T12:22:30+0200" | |
}, | |
"adresse": { | |
"id": 17054, | |
"name": "adresse", | |
"value": "", | |
"date": "2019-04-23T12:22:30+0200" | |
} | |
}, | |
"_string": "Learny Box2" | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Liste des webinaires", | |
"operationId": "api_v2_webinaires_list", | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_webinaire": 146, | |
"nom": "client 1", | |
"jours": "['lundi','mardi','mercredi','jeudi','vendredi','samedi']", | |
"nb_session": 5, | |
"nb_date": 1, | |
"horaires": "['10:00','12:00','14:00','18:00','20:00']", | |
"feries": "['2017-02-22','2017-02-23','2017-02-24','2017-02-25','2017-02-26','2017-02-27','2017-02-28','2017-03-01','2017-03-02','2017-03-03','2017-03-04','2017-03-05']", | |
"nb_jour_next": 0, | |
"date_today": false, | |
"date_today_from": "09:00", | |
"date_today_to": "20:00", | |
"video": "", | |
"duree_video": "02:10:30", | |
"disable_pause": false, | |
"accroche": "", | |
"description": "<p style='box-sizing: border-box; margin: 0px 0px 10px; font-size: 14px; font-family: Lato, sans-serif;'>Dans ce webinaire, vous allez apprendre :</p>\\r\\n\\r\\n<ul style='box-sizing: border-box; margin-top: 0px; margin-bottom: 10px; font-family: Lato, sans-serif; font-size: 14px;'>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 1</li>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 2</li>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 3</li>\\r\\n</ul>\\r\\n\\r\\n<p style='box-sizing: border-box; margin: 0px 0px 10px; font-size: 14px; font-family: Lato, sans-serif;'>Inscrivez-vous en remplissant le formulaire ci-contre.</p>\\r\\n", | |
"nb_auditeurs": 9999, | |
"image_inscription": "", | |
"afficher_participants": true, | |
"delta_participants": 200, | |
"simuler_participants": false, | |
"simuler_participants_start": 0, | |
"simuler_participants_min": 0, | |
"simuler_participants_max": 0, | |
"type": "publique", | |
"type_inscription": "automatique", | |
"email_inscription": false, | |
"participation_unique": false, | |
"page_confirmation": "defaut", | |
"url_page_confirmation": "", | |
"theme_inscription": "0", | |
"theme_confirmation": "0", | |
"theme_attente": "everwebinaire_attente", | |
"theme_broadcast": "", | |
"thumbnail": "", | |
"autorepondeur": "", | |
"email_rappel": false, | |
"chat": "chat", | |
"replay": true, | |
"replay_auto": false, | |
"replay_desactivation": 0, | |
"replay_redirection": "", | |
"redirection_url": "", | |
"users": "", | |
"timezone": "Europe/Paris", | |
"etat": "enattente", | |
"inscription_js": "", | |
"inscription_js_head": "", | |
"confirmation_js": "", | |
"confirmation_js_head": "", | |
"broadcast_js": "", | |
"broadcast_js_head": "", | |
"date": "2017-12-21T11:05:09+0100", | |
"rgpd": false, | |
"rgpd_text": "", | |
"rgpd_aff": false, | |
"rgpd_aff_text": "", | |
"client": { | |
"nom_client": "Learny Box" | |
}, | |
"webinaire_chats": [] | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/webinaires/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Données d'une webinaires", | |
"operationId": "api_v2_webinaires_show", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'une webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_webinaire": 146, | |
"nom": "client 1", | |
"jours": "['lundi','mardi','mercredi','jeudi','vendredi','samedi']", | |
"nb_session": 5, | |
"nb_date": 1, | |
"horaires": "['10:00','12:00','14:00','18:00','20:00']", | |
"feries": "['2017-02-22','2017-02-23','2017-02-24','2017-02-25','2017-02-26','2017-02-27','2017-02-28','2017-03-01','2017-03-02','2017-03-03','2017-03-04','2017-03-05']", | |
"nb_jour_next": 0, | |
"date_today": false, | |
"date_today_from": "09:00", | |
"date_today_to": "20:00", | |
"video": "", | |
"duree_video": "02:10:30", | |
"disable_pause": false, | |
"accroche": "", | |
"description": "<p style='box-sizing: border-box; margin: 0px 0px 10px; font-size: 14px; font-family: Lato, sans-serif;'>Dans ce webinaire, vous allez apprendre :</p>\\r\\n\\r\\n<ul style='box-sizing: border-box; margin-top: 0px; margin-bottom: 10px; font-family: Lato, sans-serif; font-size: 14px;'>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 1</li>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 2</li>\\r\\n\\t<li style='box-sizing: border-box;'>promesse 3</li>\\r\\n</ul>\\r\\n\\r\\n<p style='box-sizing: border-box; margin: 0px 0px 10px; font-size: 14px; font-family: Lato, sans-serif;'>Inscrivez-vous en remplissant le formulaire ci-contre.</p>\\r\\n", | |
"nb_auditeurs": 9999, | |
"image_inscription": "", | |
"afficher_participants": true, | |
"delta_participants": 200, | |
"simuler_participants": false, | |
"simuler_participants_start": 0, | |
"simuler_participants_min": 0, | |
"simuler_participants_max": 0, | |
"type": "publique", | |
"type_inscription": "automatique", | |
"email_inscription": false, | |
"participation_unique": false, | |
"page_confirmation": "defaut", | |
"url_page_confirmation": "", | |
"theme_inscription": "0", | |
"theme_confirmation": "0", | |
"theme_attente": "everwebinaire_attente", | |
"theme_broadcast": "", | |
"thumbnail": "", | |
"autorepondeur": "", | |
"email_rappel": false, | |
"chat": "chat", | |
"replay": true, | |
"replay_auto": false, | |
"replay_desactivation": 0, | |
"replay_redirection": "", | |
"redirection_url": "", | |
"users": "", | |
"timezone": "Europe/Paris", | |
"etat": "enattente", | |
"inscription_js": "", | |
"inscription_js_head": "", | |
"confirmation_js": "", | |
"confirmation_js_head": "", | |
"broadcast_js": "", | |
"broadcast_js_head": "", | |
"date": "2017-12-21T11:05:09+0100", | |
"rgpd": false, | |
"rgpd_text": "", | |
"rgpd_aff": false, | |
"rgpd_aff_text": "", | |
"client": { | |
"nom_client": "Learny Box" | |
}, | |
"webinaire_chats": [] | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/chat/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Chat d'un webinaire", | |
"operationId": "api_v2_webinaires_chat_list", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_chat": 1, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"message": "test message 1", | |
"date": "2017-12-27T08:05:17+0100" | |
}, | |
{ | |
"id_chat": 2, | |
"prenom": "Learny", | |
"email": "[email protected]", | |
"message": "test message 2", | |
"date": "2017-12-27T08:06:11+0100" | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 2, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/webinaires/1/chat/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/inscrits/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Liste des inscrits d'un webinaire", | |
"operationId": "api_v2_webinaires_inscrits_list", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_inscrit": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-05T15:06:02+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"webinaire_user": { | |
"id_user": 1, | |
"prenom": "Test", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "FR", | |
"disabled": false, | |
"newsletter": true, | |
"date_webinaire": "2018-01-10T10:00:00+0100" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/webinaires/1/inscrits/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/inscrits/{id_inscrit}/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Données d'un inscrit à un webinaire", | |
"operationId": "api_v2_webinaires_inscrits_show", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_inscrit", | |
"in": "path", | |
"description": "Identifiant d'un inscrit", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_inscrit": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-05T15:06:02+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"webinaire_user": { | |
"id_user": 1, | |
"prenom": "Test", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "FR", | |
"disabled": false, | |
"newsletter": true, | |
"date_webinaire": "2018-01-10T10:00:00+0100" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/messages/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Liste des messages d'un webinaire", | |
"operationId": "api_v2_webinaires_messages_list", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_message": 1, | |
"prenom": "Test", | |
"message": "test message", | |
"date": "2017-02-02T21:31:12+0100", | |
"webinaire_user": { | |
"id_user": 1, | |
"prenom": "Test", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "FR", | |
"disabled": false, | |
"newsletter": true, | |
"date_webinaire": "2017-12-21T08:00:00+0100" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/webinaires/1/messages/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/participants/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Liste des participants d'un webinaire", | |
"operationId": "api_v2_webinaires_participants_list", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": [ | |
{ | |
"id_participant": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-05T15:06:02+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"webinaire_user": { | |
"id_user": 1, | |
"prenom": "Test", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "FR", | |
"disabled": false, | |
"newsletter": true, | |
"date_webinaire": "2018-01-10T10:00:00+0100" | |
} | |
} | |
], | |
"message": "", | |
"offset": 0, | |
"limit": 100, | |
"total": 1, | |
"_links": { | |
"self": { | |
"href": "https://api.learnybox.com/api/v2/webinaires/1/participants/?limit=100&offset=0", | |
"rel": "self" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/api/v2/webinaires/{id_webinaire}/participants/{id_participant}/": { | |
"get": { | |
"tags": [ | |
"Webinaires" | |
], | |
"summary": "Données d'un participant à un webinaire", | |
"operationId": "api_v2_webinaires_participants_show", | |
"parameters": [ | |
{ | |
"name": "id_webinaire", | |
"in": "path", | |
"description": "Identifiant d'un webinaire", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "id_participant", | |
"in": "path", | |
"description": "Identifiant d'un participant", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiResponse" | |
}, | |
"example": { | |
"status": true, | |
"data": { | |
"id_participant": 1, | |
"type": "participant", | |
"enattente": false, | |
"replay": false, | |
"cpg": "", | |
"aff": "", | |
"date_inscr": "2018-01-05T15:06:02+0100", | |
"date_replay": "-0001-11-30T00:00:00+0009", | |
"webinaire_user": { | |
"id_user": 1, | |
"prenom": "Test", | |
"email": "[email protected]", | |
"telephone": "", | |
"pays": "FR", | |
"disabled": false, | |
"newsletter": true, | |
"date_webinaire": "2018-01-10T10:00:00+0100" | |
} | |
}, | |
"message": "" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"components": { | |
"schemas": { | |
"ApiResponse": { | |
"type": "array", | |
"items": { | |
"properties": { | |
"status": { | |
"description": "Statut de la réponse (true ou false)", | |
"type": "boolean" | |
}, | |
"data": { | |
"description": "Données de la réponse", | |
"type": "array", | |
"items": {} | |
}, | |
"message": { | |
"description": "Message de la réponse", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"example": { | |
"status": true, | |
"data": [], | |
"message": "" | |
}, | |
"$ref": "ApiResponse" | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"httpBearer": [] | |
} | |
], | |
"tags": [ | |
{ | |
"name": "Token d'authentification", | |
"description": "" | |
}, | |
{ | |
"name": "Formations", | |
"description": "" | |
}, | |
{ | |
"name": "Affiliations", | |
"description": "" | |
}, | |
{ | |
"name": "Mail", | |
"description": "" | |
}, | |
{ | |
"name": "Messages", | |
"description": "" | |
}, | |
{ | |
"name": "Support", | |
"description": "" | |
}, | |
{ | |
"name": "Transactions", | |
"description": "" | |
}, | |
{ | |
"name": "Utilisateurs", | |
"description": "" | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment