Splash Page
GET https://www.your.bzh/api/splash-pages/
curl --request GET \
--url 'https://www.your.bzh/api/splash-pages/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/api/splash-pages/' \
--header 'Authorization: Bearer {api_key}' \
| Paramètres | Détails | Description |
|---|---|---|
| page | Optionnel Entier | Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut 1. |
| results_per_page | Optionnel Entier | Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut, 25. |
{
"data": [
{
"id": 1,
"name": "Development",
"color": "#0e23cc",
"last_datetime": "2021-03-14 21:22:37",
"datetime": "2021-02-04 17:51:07"
},
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://www.your.bzh/api/projects?&page=1",
"last": "https://www.your.bzh/api/projects?&page=1",
"next": null,
"prev": null,
"self": "https://www.your.bzh/api/projects?&page=1"
}
}
GET https://www.your.bzh/api/splash-pages/{splash_page_id}
curl --request GET \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"name": "Development",
"color": "#0e23cc",
"last_datetime": "2021-03-14 21:22:37",
"datetime": "2021-02-04 17:51:07"
}
}
POST https://www.your.bzh/api/projects
| Paramètres | Détails | Description |
|---|---|---|
| name | Requis Chaîne | - |
| title | Optionnel Chaîne | - |
| logo | Optionnel Fichier | - |
| favicon | Optionnel Fichier | - |
| opengraph | Optionnel Fichier | - |
| description | Optionnel Chaîne | - |
| secondary_button_name | Optionnel Chaîne | - |
| secondary_button_url | Optionnel Chaîne | - |
| custom_css | Optionnel Chaîne | - |
| custom_js | Optionnel Chaîne | - |
| ads_header | Optionnel Chaîne | - |
| ads_footer | Optionnel Chaîne | - |
| link_unlock_seconds | Optionnel Entier | - |
| auto_redirect | Optionnel Booléen | - |
curl --request POST \
--url 'https://www.your.bzh/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
--url 'https://www.your.bzh/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
{
"data": {
"id": 1
}
}
POST https://www.your.bzh/api/splash-pages/{splash_page_id}
| Paramètres | Détails | Description |
|---|---|---|
| name | Optionnel Chaîne | - |
| title | Optionnel Chaîne | - |
| logo | Optionnel Fichier | - |
| favicon | Optionnel Fichier | - |
| opengraph | Optionnel Fichier | - |
| description | Optionnel Chaîne | - |
| secondary_button_name | Optionnel Chaîne | - |
| secondary_button_url | Optionnel Chaîne | - |
| custom_css | Optionnel Chaîne | - |
| custom_js | Optionnel Chaîne | - |
| ads_header | Optionnel Chaîne | - |
| ads_footer | Optionnel Chaîne | - |
| link_unlock_seconds | Optionnel Entier | - |
| auto_redirect | Optionnel Booléen | - |
curl --request POST \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
{
"data": {
"id": 1
}
}
DELETE https://www.your.bzh/api/splash-pages/{splash_page_id}
curl --request DELETE \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \