Documentation complète de l'API Aonyx

Base URL

https://api.aonyx.dev

Authentication

Dashboard Aonyx

Type Bearer Token
Required Yes
Description Authentification via token Bearer pour le dashboard Aonyx
Format de l'en-tête
Authorization: Bearer <votre-token>

Note: Pour obtenir un token, utilisez l'endpoint /login avec vos identifiants.

API Standard

Type API Key
Required Yes
Description Clé API pour identifier la base de données
Format de l'en-tête
X-API-Key: <votre-clé-api>

Note: La clé API doit être fournie pour toutes les requêtes hors dashboard.

Health Check

Vérification de l'état du système

GET /health

Vérifie l'état des différents services

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Le système fonctionne correctement 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

500 Un ou plusieurs services sont indisponibles

Administration

Fonctionnalités d'administration et groupes d'autorisation

GET /dashboard/admin-group-authorisations

Afficher la liste des autorisations de groupe@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/admin-group-authorisations

Créer une nouvelle autorisation de groupe@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/admin-group-authorisations/{admin_group_authorisation}

Afficher une autorisation de groupe spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
admin_group_authorisation *required string Yes Admin group authorisation
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/admin-group-authorisations/{admin_group_authorisation}

Mettre à jour une autorisation de groupe@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
admin_group_authorisation *required string Yes Admin group authorisation
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "admin_group_authorisation": "exemple_admin_group_authorisation",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/admin-group-authorisations/{admin_group_authorisation}

Supprimer une autorisation de groupe@param int $id@return JsonResponse

Parameters

Name Type Required Description
admin_group_authorisation *required string Yes Admin group authorisation
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Autres

Autres fonctionnalités du système

POST /dashboard/login

Authentifier un utilisateur du dashboard.@param \Illuminate\Http\Request $request@return \Illuminate\Http\JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/logout

Déconnecter l'utilisateur du dashboard.@param \Illuminate\Http\Request $request@return \Illuminate\Http\JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/me

Obtenir les informations de l'utilisateur connecté.@param \Illuminate\Http\Request $request@return \Illuminate\Http\JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/images

Afficher la liste des images@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/images

Télécharger et créer une nouvelle image@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/images/{image}

Afficher une image spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
image *required string Yes Image
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/images/{image}

Mettre à jour les informations d'une image@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
image *required string Yes Image
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "image": "exemple_image",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/images/{image}

Supprimer une image@param int $id@return JsonResponse

Parameters

Name Type Required Description
image *required string Yes Image
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myaccmgmt

Afficher la liste des comptes@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myaccmgmt

Créer un nouveau compte@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myaccmgmt/{myaccmgmt}

Afficher un compte spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt *required string Yes Myaccmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myaccmgmt/{myaccmgmt}

Mettre à jour un compte@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt *required string Yes Myaccmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myaccmgmt": "exemple_myaccmgmt",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myaccmgmt/{myaccmgmt}

Supprimer un compte@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt *required string Yes Myaccmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-accmgmt

Afficher la liste des associations agence-compte@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myagency-accmgmt

Créer une nouvelle association agence-compte@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-accmgmt/{myagency_accmgmt}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_accmgmt *required string Yes Myagency accmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myagency-accmgmt/{myagency_accmgmt}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_accmgmt *required string Yes Myagency accmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myagency_accmgmt": "exemple_myagency_accmgmt",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myagency-accmgmt/{myagency_accmgmt}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_accmgmt *required string Yes Myagency accmgmt
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency

Afficher la liste des agences@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myagency

Créer une nouvelle agence@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency/{myagency}

Afficher une agence spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency *required string Yes Myagency
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myagency/{myagency}

Mettre à jour une agence@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency *required string Yes Myagency
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myagency": "exemple_myagency",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myagency/{myagency}

Supprimer une agence@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency *required string Yes Myagency
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-mymcrft

Afficher la liste des associations agence-minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myagency-mymcrft

Créer une nouvelle association agence-minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-mymcrft/{myagency_mymcrft}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mymcrft *required string Yes Myagency mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myagency-mymcrft/{myagency_mymcrft}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mymcrft *required string Yes Myagency mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myagency_mymcrft": "exemple_myagency_mymcrft",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myagency-mymcrft/{myagency_mymcrft}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mymcrft *required string Yes Myagency mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-mysite

Afficher la liste des associations agence-site@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myagency-mysite

Créer une nouvelle association agence-site@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-mysite/{myagency_mysite}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mysite *required string Yes Myagency mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myagency-mysite/{myagency_mysite}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mysite *required string Yes Myagency mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myagency_mysite": "exemple_myagency_mysite",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myagency-mysite/{myagency_mysite}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_mysite *required string Yes Myagency mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mymcrft

Afficher la liste des comptes Minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/mymcrft

Créer un nouveau compte Minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mymcrft/{mymcrft}

Afficher un compte Minecraft spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft *required string Yes Mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/mymcrft/{mymcrft}

Mettre à jour un compte Minecraft@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft *required string Yes Mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "mymcrft": "exemple_mymcrft",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/mymcrft/{mymcrft}

Supprimer un compte Minecraft@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft *required string Yes Mymcrft
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mysite

Afficher la liste des sites@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/mysite

Créer un nouveau site@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mysite/{mysite}

Afficher un site spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite *required string Yes Mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/mysite/{mysite}

Mettre à jour un site@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite *required string Yes Mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "mysite": "exemple_mysite",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/mysite/{mysite}

Supprimer un site@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite *required string Yes Mysite
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/superadmin-menu

Afficher la liste des éléments du menu@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/superadmin-menu

Créer un nouvel élément de menu@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/superadmin-menu/{superadmin_menu}

Afficher un élément de menu spécifique@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
superadmin_menu *required string Yes Superadmin menu
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/superadmin-menu/{superadmin_menu}

Mettre à jour un élément de menu@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
superadmin_menu *required string Yes Superadmin menu
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "superadmin_menu": "exemple_superadmin_menu",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/superadmin-menu/{superadmin_menu}

Supprimer un élément de menu@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
superadmin_menu *required string Yes Superadmin menu
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Journal des modifications

Suivi des modifications du système

GET /dashboard/changelogs

Afficher la liste des entrées du changelog@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/changelogs

Créer une nouvelle entrée dans le changelog@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/changelogs/{changelog}

Afficher une entrée spécifique du changelog@param int $id@return JsonResponse

Parameters

Name Type Required Description
changelog *required string Yes Changelog
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/changelogs/{changelog}

Mettre à jour une entrée du changelog@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
changelog *required string Yes Changelog
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "changelog": "exemple_changelog",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/changelogs/{changelog}

Supprimer une entrée du changelog@param int $id@return JsonResponse

Parameters

Name Type Required Description
changelog *required string Yes Changelog
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Composants

Gestion des composants du système

GET /dashboard/components

Afficher la liste des composants@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/components

Créer un nouveau composant@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/components/{component}

Afficher un composant spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
component *required string Yes Component
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/components/{component}

Mettre à jour un composant@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
component *required string Yes Component
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "component": "exemple_component",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/components/{component}

Supprimer un composant@param int $id@return JsonResponse

Parameters

Name Type Required Description
component *required string Yes Component
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Tâches planifiées

Configuration et suivi des tâches automatisées

GET /dashboard/crons

Afficher la liste des tâches planifiées@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/crons

Créer une nouvelle tâche planifiée@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/crons/{cron}

Afficher une tâche planifiée spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
cron *required string Yes Cron
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/crons/{cron}

Mettre à jour une tâche planifiée@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
cron *required string Yes Cron
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "cron": "exemple_cron",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/crons/{cron}

Supprimer une tâche planifiée@param int $id@return JsonResponse

Parameters

Name Type Required Description
cron *required string Yes Cron
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Sécurité

Gestion de la sécurité et des adresses IP

GET /dashboard/ips

Afficher la liste des adresses IP@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ips

Créer une nouvelle entrée d'adresse IP@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ips/{ip}

Afficher une adresse IP spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ip *required string Yes Ip
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ips/{ip}

Mettre à jour une adresse IP@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ip *required string Yes Ip
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ip": "exemple_ip",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ips/{ip}

Supprimer une adresse IP@param int $id@return JsonResponse

Parameters

Name Type Required Description
ip *required string Yes Ip
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Médias

Gestion des médias, images et fichiers

GET /dashboard/medias

Afficher la liste des médias@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/medias

Télécharger et créer un nouveau média@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/medias/{media}

Afficher un média spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
media *required string Yes Media
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/medias/{media}

Mettre à jour les informations d'un média@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
media *required string Yes Media
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "media": "exemple_media",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/medias/{media}

Supprimer un média@param int $id@return JsonResponse

Parameters

Name Type Required Description
media *required string Yes Media
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Modules

Gestion des modules et leurs associations utilisateurs

GET /dashboard/modules

Afficher la liste des modules@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/modules

Créer un nouveau module@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/modules/{module}

Afficher un module spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
module *required string Yes Module
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/modules/{module}

Mettre à jour un module@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
module *required string Yes Module
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "module": "exemple_module",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/modules/{module}

Supprimer un module@param int $id@return JsonResponse

Parameters

Name Type Required Description
module *required string Yes Module
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Utilisateurs

Gestion des utilisateurs et leurs permissions

GET /dashboard/myaccmgmt-users

Afficher la liste des utilisateurs de comptes@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myaccmgmt-users

Créer une nouvelle association utilisateur-compte@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myaccmgmt-users/{myaccmgmt_user}

Afficher une association utilisateur-compte spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt_user *required string Yes Myaccmgmt user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myaccmgmt-users/{myaccmgmt_user}

Mettre à jour une association utilisateur-compte@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt_user *required string Yes Myaccmgmt user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myaccmgmt_user": "exemple_myaccmgmt_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myaccmgmt-users/{myaccmgmt_user}

Supprimer une association utilisateur-compte@param int $id@return JsonResponse

Parameters

Name Type Required Description
myaccmgmt_user *required string Yes Myaccmgmt user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-users

Afficher la liste des associations agence-utilisateur@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/myagency-users

Créer une nouvelle association agence-utilisateur@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/myagency-users/{myagency_user}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_user *required string Yes Myagency user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/myagency-users/{myagency_user}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_user *required string Yes Myagency user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "myagency_user": "exemple_myagency_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/myagency-users/{myagency_user}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
myagency_user *required string Yes Myagency user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mymcrft-users

Afficher la liste des associations utilisateur-compte Minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/mymcrft-users

Créer une nouvelle association utilisateur-compte Minecraft@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mymcrft-users/{mymcrft_user}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft_user *required string Yes Mymcrft user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/mymcrft-users/{mymcrft_user}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft_user *required string Yes Mymcrft user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "mymcrft_user": "exemple_mymcrft_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/mymcrft-users/{mymcrft_user}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
mymcrft_user *required string Yes Mymcrft user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mysite-users

Afficher la liste des associations utilisateur-site@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/mysite-users

Créer une nouvelle association utilisateur-site@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/mysite-users/{mysite_user}

Afficher une association spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite_user *required string Yes Mysite user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/mysite-users/{mysite_user}

Mettre à jour une association@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite_user *required string Yes Mysite user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "mysite_user": "exemple_mysite_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/mysite-users/{mysite_user}

Supprimer une association@param int $id@return JsonResponse

Parameters

Name Type Required Description
mysite_user *required string Yes Mysite user
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Précommandes

Gestion des précommandes

GET /dashboard/preorders

Afficher la liste des précommandes@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/preorders

Créer une nouvelle précommande@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/preorders/{preorder}

Afficher une précommande spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
preorder *required string Yes Preorder
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/preorders/{preorder}

Mettre à jour une précommande@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
preorder *required string Yes Preorder
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "preorder": "exemple_preorder",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/preorders/{preorder}

Supprimer une précommande@param int $id@return JsonResponse

Parameters

Name Type Required Description
preorder *required string Yes Preorder
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Serveurs

Gestion de serveurs

GET /dashboard/servers

Afficher la liste des serveurs@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/servers

Créer un nouveau serveur@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/servers/{server}

Afficher un serveur spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
server *required string Yes Server
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/servers/{server}

Mettre à jour un serveur@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
server *required string Yes Server
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "server": "exemple_server",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/servers/{server}

Supprimer un serveur@param int $id@return JsonResponse

Parameters

Name Type Required Description
server *required string Yes Server
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Facturation

Gestion des factures, produits et abonnements Stripe

GET /dashboard/stripe-invoices

Afficher la liste des factures@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/stripe-invoices

Créer une nouvelle facture@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/stripe-invoices/{stripe_invoice}

Afficher une facture spécifique@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_invoice *required string Yes Stripe invoice
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/stripe-products

Afficher la liste des produits@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/stripe-products

Créer un nouveau produit@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/stripe-products/{stripe_product}

Afficher un produit spécifique@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_product *required string Yes Stripe product
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/stripe-products/{stripe_product}

Mettre à jour un produit@param Request $request@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_product *required string Yes Stripe product
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "stripe_product": "exemple_stripe_product",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/stripe-products/{stripe_product}

Supprimer un produit@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_product *required string Yes Stripe product
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/stripe-subscriptions

Afficher la liste des abonnements@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/stripe-subscriptions

Créer un nouvel abonnement@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/stripe-subscriptions/{stripe_subscription}

Afficher un abonnement spécifique@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_subscription *required string Yes Stripe subscription
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/stripe-subscriptions/{stripe_subscription}

Mettre à jour un abonnement@param Request $request@param string $id@return JsonResponse

Parameters

Name Type Required Description
stripe_subscription *required string Yes Stripe subscription
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "stripe_subscription": "exemple_stripe_subscription",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Support - Général

Services de support et assistance générale

GET /dashboard/support

Afficher la liste des demandes de support@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/support

Créer une nouvelle demande de support@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/support/{support}

Afficher une demande de support spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
support *required string Yes Support
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/support/{support}

Mettre à jour une demande de support@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
support *required string Yes Support
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "support": "exemple_support",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/support-types

Afficher la liste des types de support@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/support-types

Créer un nouveau type de support@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/support-types/{support_type}

Afficher un type de support spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
support_type *required string Yes Support type
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/support-types/{support_type}

Mettre à jour un type de support@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
support_type *required string Yes Support type
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "support_type": "exemple_support_type",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/support-types/{support_type}

Supprimer un type de support@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
support_type *required string Yes Support type
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Templates

Gestion des templates et leurs layouts

GET /dashboard/templates

Afficher la liste des templates@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/templates

Créer un nouveau template@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/templates/{template}

Afficher un template spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
template *required string Yes Template
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/templates/{template}

Mettre à jour un template@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
template *required string Yes Template
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "template": "exemple_template",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/templates/{template}

Supprimer un template@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
template *required string Yes Template
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/template-layouts

Afficher la liste des layouts@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/template-layouts

Créer un nouveau layout@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/template-layouts/{template_layout}

Afficher un layout spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
template_layout *required string Yes Template layout
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/template-layouts/{template_layout}

Mettre à jour un layout@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
template_layout *required string Yes Template layout
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "template_layout": "exemple_template_layout",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/template-layouts/{template_layout}

Supprimer un layout@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
template_layout *required string Yes Template layout
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Support - Tickets

Système de tickets, catégories, priorités et réponses

GET /dashboard/tickets

Afficher la liste des tickets@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/tickets

Créer un nouveau ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/tickets/{ticket}

Afficher un ticket spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket *required string Yes Ticket
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/tickets/{ticket}

Mettre à jour un ticket@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket *required string Yes Ticket
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket": "exemple_ticket",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/tickets/{ticket}

Supprimer un ticket@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket *required string Yes Ticket
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-categories

Afficher la liste des catégories de tickets@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ticket-categories

Créer une nouvelle catégorie de ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-categories/{ticket_category}

Afficher une catégorie de ticket spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category *required string Yes Ticket category
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ticket-categories/{ticket_category}

Mettre à jour une catégorie de ticket@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category *required string Yes Ticket category
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket_category": "exemple_ticket_category",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ticket-categories/{ticket_category}

Supprimer une catégorie de ticket@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category *required string Yes Ticket category
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-category-subjects

Afficher la liste des sujets de catégories de tickets@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ticket-category-subjects

Créer un nouveau sujet de catégorie de ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-category-subjects/{ticket_category_subject}

Afficher un sujet de catégorie spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category_subject *required string Yes Ticket category subject
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ticket-category-subjects/{ticket_category_subject}

Mettre à jour un sujet de catégorie@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category_subject *required string Yes Ticket category subject
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket_category_subject": "exemple_ticket_category_subject",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ticket-category-subjects/{ticket_category_subject}

Supprimer un sujet de catégorie@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_category_subject *required string Yes Ticket category subject
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-priorities

Afficher la liste des priorités de tickets@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ticket-priorities

Créer une nouvelle priorité de ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-priorities/{ticket_priority}

Afficher une priorité de ticket spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_priority *required string Yes Ticket priority
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ticket-priorities/{ticket_priority}

Mettre à jour une priorité de ticket@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_priority *required string Yes Ticket priority
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket_priority": "exemple_ticket_priority",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ticket-priorities/{ticket_priority}

Supprimer une priorité de ticket@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_priority *required string Yes Ticket priority
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-replies

Afficher la liste des réponses pour un ticket spécifique@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ticket-replies

Créer une nouvelle réponse pour un ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-replies/{ticket_reply}

Afficher une réponse spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_reply *required string Yes Ticket reply
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ticket-replies/{ticket_reply}

Mettre à jour une réponse@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_reply *required string Yes Ticket reply
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket_reply": "exemple_ticket_reply",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ticket-replies/{ticket_reply}

Supprimer une réponse@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_reply *required string Yes Ticket reply
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-states

Afficher la liste des états de tickets@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /dashboard/ticket-states

Créer un nouvel état de ticket@param Request $request@return JsonResponse

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /dashboard/ticket-states/{ticket_state}

Afficher un état de ticket spécifique@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_state *required string Yes Ticket state
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /dashboard/ticket-states/{ticket_state}

Mettre à jour un état de ticket@param Request $request@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_state *required string Yes Ticket state
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Body

{
    "ticket_state": "exemple_ticket_state",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /dashboard/ticket-states/{ticket_state}

Supprimer un état de ticket@param int $id@return JsonResponse

Parameters

Name Type Required Description
ticket_state *required string Yes Ticket state
id *required int Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Kcal Calculator

API de gestion de l'alimentation et du suivi calorique

POST /kcal-calculator/auth/register

Register

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/auth/login

Login

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/auth/logout

Logout

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/auth/refresh

Refresh

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/foods

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/foods/search

Recherche des éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/foods/{id}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/foods

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/foods/{id}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/foods/{id}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/foods/import

Importe des données

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/foods/export

Exporte les données

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/foods/{id}/favorite

AddToFavorites

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/foods/{id}/favorite

RemoveFromFavorites

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/meals

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/meals/{id}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/meals

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/meals/{id}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/meals/{id}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/meals/templates

Récupérer tous les modèles de repas de l'utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/meals/templates/{id}

Récupérer un modèle de repas spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/meals/templates

Créer un nouveau modèle de repas

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/meals/templates/{id}

Mettre à jour un modèle de repas

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/meals/templates/{id}

Supprimer un modèle de repas

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/nutrition/goals

Récupérer les objectifs nutritionnels de l'utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/nutrition/goals

Mettre à jour les objectifs nutritionnels

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/nutrition/progress

Obtenir la progression nutritionnelle

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/nutrition/recommendations

Obtenir des recommandations nutritionnelles

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/profiles

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/profiles/{id}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/profiles

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/profiles/{id}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/profiles/{id}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/profiles/user/{userId}

GetProfileByUser

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
userId *required mixed Yes User id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/profiles/calculate-macros

CalculateMacros

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/tracking-days

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/tracking-days/{id}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/tracking-days

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/tracking-days/{id}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/tracking-days/{id}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/tracking-days/user/{userId}

GetUserDays

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
userId *required mixed Yes User id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/tracking-days/{id}/totals

GetDailyTotals

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/users/profile

Profile

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /kcal-calculator/users/profile

UpdateProfile

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /kcal-calculator/users/{userId}/favorites

GetFavorites

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
userId *required mixed Yes User id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /kcal-calculator/users/{userId}/favorites

AddFavorite

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
userId *required mixed Yes User id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "userId": "exemple_userId"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /kcal-calculator/users/{userId}/favorites/{foodId}

RemoveFavorite

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
foodId *required string Yes Food id
userId *required mixed Yes User id
foodId *required mixed Yes Food id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Finance Manager

API de gestion financière et comptabilité

GET /finance-manager/accounts

Afficher la liste de tous les comptes d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/accounts/{id}

Afficher un compte spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/accounts

Créer un nouveau compte

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/accounts/{id}

Mettre à jour un compte existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /finance-manager/accounts/{id}

Supprimer un compte

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/auth/register

Enregistre un nouvel utilisateur@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/auth/login

Authentifie un utilisateur et retourne un token JWT@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/auth/me

Récupère les informations de l'utilisateur@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/categories

Afficher la liste de toutes les catégories d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/categories/{id}

Afficher une catégorie spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/categories

Créer une nouvelle catégorie

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/categories/{id}

Mettre à jour une catégorie existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /finance-manager/categories/{id}

Supprimer une catégorie

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/fixed-expenses

Afficher la liste de toutes les dépenses fixes d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/fixed-expenses/{id}

Afficher une dépense fixe spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/fixed-expenses

Créer une nouvelle dépense fixe

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/fixed-expenses/{id}

Mettre à jour une dépense fixe existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /finance-manager/fixed-expenses/{id}

Supprimer une dépense fixe

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/profiles

Afficher la liste de tous les profils

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/profiles/{id}

Afficher un profil spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/profiles

Créer un nouveau profil

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/profiles/{id}

Mettre à jour un profil existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /finance-manager/profiles/{id}

Supprimer un profil

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/system-logs

Afficher la liste des logs système avec filtrage

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/system-logs/{id}

Afficher un log système spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/system-logs

Créer un nouveau log système (généralement utilisé en interne)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/system-logs/purge

Supprimer les logs système plus anciens qu'une certaine date

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/system-logs/stats

Obtenir les statistiques des logs système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/transactions

Afficher la liste de toutes les transactions d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /finance-manager/transactions/{id}

Afficher une transaction spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /finance-manager/transactions

Créer une nouvelle transaction

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/transactions/{id}

Mettre à jour une transaction existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /finance-manager/transactions/{id}

Supprimer une transaction

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /finance-manager/transactions/{id}/verify

Marquer une transaction comme vérifiée

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

TalentNet

API de gestion des talents et freelances

POST /talentnet/auth/register

Enregistre un nouvel utilisateur TalentNet@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/auth/login

Authentifie un utilisateur TalentNet et retourne un token JWT@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/auth/me

Récupère les informations de l'utilisateur connecté@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/auth/logout

Déconnexion d'un utilisateur (invalidation du token)@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/contracts

Liste tous les contrats avec filtres et pagination

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/contracts/{contract}

Affiche un contrat spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contract *required string Yes Contract
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts

Crée un nouveau contrat

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/contracts/{contract}

Met à jour un contrat existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contract *required string Yes Contract
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "contract": "exemple_contract",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/contracts/{contract}

Supprime un contrat (soft delete)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contract *required string Yes Contract
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts/{id}/sign-client

Actions spéciales sur les contrats

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts/{id}/sign-freelance

SignByFreelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts/{id}/complete

Complete

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts/{id}/cancel

Cancel

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/contracts/{id}/dispute

Dispute

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/freelance-profiles

Liste tous les profils freelance avec filtres et pagination

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/freelance-profiles/{freelance_profile}

Affiche un profil freelance spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/freelance-profiles

Crée un nouveau profil freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/freelance-profiles/{freelance_profile}

Met à jour un profil freelance existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_profile": "exemple_freelance_profile",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/freelance-profiles/{freelance_profile}

Supprime un profil freelance (soft delete)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/freelance-profiles/search

Recherche avancée de profils

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents

Liste des documents KYC avec filtres

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/{kyc_document}

Affiche un document KYC spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
kyc_document *required string Yes Kyc document
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/kyc-documents

Upload et création d'un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/kyc-documents/{kyc_document}

Mise à jour d'un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
kyc_document *required string Yes Kyc document
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "kyc_document": "exemple_kyc_document",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/kyc-documents/{kyc_document}

Suppression d'un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
kyc_document *required string Yes Kyc document
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/kyc-documents/{id}/approve

Approuver un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/kyc-documents/{id}/reject

Rejeter un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/{id}/download

Télécharger un document KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required string Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/stats

Statistiques des documents KYC

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/pending

Documents en attente de vérification

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/expired

Documents expirés

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/kyc-documents/expiring-soon

Documents expirant bientôt

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/notifications

Liste toutes les notifications avec filtres et pagination

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/notifications/{notification}

Affiche une notification spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification *required string Yes Notification
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/notifications

Crée une nouvelle notification

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/notifications/{notification}

Met à jour une notification existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification *required string Yes Notification
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "notification": "exemple_notification",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/notifications/{notification}

Supprime une notification

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification *required string Yes Notification
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/notifications/{id}/mark-read

Actions spéciales sur les notifications

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/notifications/mark-all-read

MarkAllAsRead

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/notifications/unread-count

GetUnreadCount

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/notifications/project

Créer des notifications spécialisées

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/notifications/proposal

CreateProposalNotification

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/projects

Liste tous les projets avec filtres et pagination

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/projects/{project}

Affiche un projet spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
project *required string Yes Project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/projects

Crée un nouveau projet

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/projects/{project}

Met à jour un projet existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
project *required string Yes Project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "project": "exemple_project",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/projects/{project}

Supprime un projet (soft delete)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
project *required string Yes Project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/projects/{id}/publish

Actions spéciales sur les projets

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/proposals

Liste toutes les propositions avec filtres et pagination

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/proposals/{proposal}

Affiche une proposition spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
proposal *required string Yes Proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/proposals

Crée une nouvelle proposition

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/proposals/{proposal}

Met à jour une proposition existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
proposal *required string Yes Proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "proposal": "exemple_proposal",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/proposals/{proposal}

Supprime une proposition (soft delete)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
proposal *required string Yes Proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/proposals/{id}/accept

Actions spéciales sur les propositions

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/proposals/{id}/reject

Reject

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/proposals/{id}/withdraw

Withdraw

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/test/ping

Test de connectivité général

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/test/database

Test de la base de données

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/test/tables

Test des tables TalentNet

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/test/system

Test complet du système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/test/info

Informations détaillées sur l'API

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/users

Récupère tous les utilisateurs avec pagination@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /talentnet/users/{user}

Récupère un utilisateur spécifique par son ID@param Request $request@param string $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /talentnet/users

Crée un nouvel utilisateur@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /talentnet/users/{user}

Met à jour un utilisateur existant@param Request $request@param string $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "user": "exemple_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /talentnet/users/{user}

Supprime un utilisateur (soft delete)@param Request $request@param string $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

NutriCal

Gestion de nutrical

GET /nutrical/logs

Liste tous les logs d'activité

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/logs/{id}

Affiche un log spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /nutrical/logs/{id}

Supprime un log

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/logs/purge

Supprime tous les logs plus anciens qu'une certaine date

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/logs/export

Exporte les logs au format CSV

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/logs/stats

Récupère les statistiques d'activité

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/versions

Liste toutes les versions de l'application

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/versions/{id}

Affiche une version spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/versions

Crée une nouvelle version

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /nutrical/versions/{id}

Met à jour une version existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /nutrical/versions/{id}

Supprime une version

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/versions/check

Vérifie si une mise à jour est disponible

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/auth/register

Inscription d'un nouvel utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/auth/login

Connexion d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/auth/verify/{token}

Vérification d'un compte utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
token *required string Yes Token
token *required mixed Yes Token

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/auth/logout

Déconnexion d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/auth/forgot-password

Demande de réinitialisation de mot de passe

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/auth/reset-password

Réinitialisation du mot de passe

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/activations

Liste toutes les activations de licences

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/activations/{id}

Affiche une activation spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/activations/{id}/deactivate

Désactive une activation spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/activations/{id}/reactivate

Réactive une activation désactivée

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/activations/license/{licenseId}

Liste les activations pour une licence spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
licenseId *required string Yes License id
licenseId *required mixed Yes License id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/activations/user/{userId}

Liste les activations pour un utilisateur spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
userId *required string Yes User id
userId *required mixed Yes User id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/licenses

Liste toutes les licences

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/licenses/{id}

Affiche une licence spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/licenses

Crée une nouvelle licence

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /nutrical/licenses/{id}

Met à jour une licence existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /nutrical/licenses/{id}

Supprime une licence

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/licenses/activate

Active une licence pour un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/licenses/deactivate

Désactive une licence pour un appareil

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/licenses/verify

Vérifie la validité d'une licence

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/stats/dashboard

Récupère les statistiques générales du système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/stats/licenses

Génère un rapport sur les licences

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/stats/users

Génère un rapport sur les utilisateurs

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/stats/activities

Génère un rapport sur les activités

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/settings

Liste tous les paramètres système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/settings/{key}

Affiche un paramètre spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
key *required string Yes Key
key *required mixed Yes Key

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /nutrical/settings/{key}

Met à jour un paramètre existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
key *required string Yes Key
key *required mixed Yes Key

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "key": "exemple_key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/settings

Crée un nouveau paramètre système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /nutrical/settings/{key}

Supprime un paramètre système

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
key *required string Yes Key
key *required mixed Yes Key

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/settings/reset

Réinitialise tous les paramètres système aux valeurs par défaut

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/users

Liste tous les utilisateurs

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/users/{id}

Affiche un utilisateur spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/users

Crée un nouvel utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /nutrical/users/{id}

Met à jour un utilisateur existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /nutrical/users/{id}

Supprime un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/users/{id}/resend-verification

Renvoie un email de vérification

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /nutrical/users/{id}/assign-license

Attribue une licence à un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /nutrical/users/{id}/licenses

Liste les licences d'un utilisateur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Article

Gestion de article

GET /article-categories

Affiche la liste des catégories d'articles

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /article-categories/{article_category}

Affiche une catégorie d'article par son ID ou son alias

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_category *required string Yes Article category
idOrAlias *required mixed Yes Id or alias

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /article-categories

Crée une nouvelle catégorie d'article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /article-categories/{article_category}

Met à jour une catégorie d'article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_category *required string Yes Article category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "article_category": "exemple_article_category",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /article-categories/{article_category}

Supprime une catégorie d'article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_category *required string Yes Article category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /article-comments

Affiche la liste des commentaires d'articles

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /article-comments/{article_comment}

Affiche un commentaire d'article spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_comment *required string Yes Article comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /article-comments

Crée un nouveau commentaire d'article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /article-comments/{article_comment}

Met à jour un commentaire d'article existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_comment *required string Yes Article comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "article_comment": "exemple_article_comment",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /article-comments/{article_comment}

Supprime un commentaire d'article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article_comment *required string Yes Article comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /articles

Affiche la liste des articles

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /articles/{article}

Affiche un article par son ID ou son slug

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article *required string Yes Article
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /articles

Crée un nouvel article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /articles/{article}

Met à jour un article existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article *required string Yes Article
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "article": "exemple_article",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /articles/{article}

Supprime un article

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
article *required string Yes Article
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /home-article

Récupère l'article marqué comme page d'accueil (home = 1)

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Blog

Gestion de blog

GET /blogs

Affiche la liste des blogs

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /blogs/{blog}

Affiche un blog spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
blog *required string Yes Blog
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /blogs

Crée un nouveau blog

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /blogs/{blog}

Met à jour un blog existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
blog *required string Yes Blog
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "blog": "exemple_blog",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /blogs/{blog}

Supprime un blog

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
blog *required string Yes Blog
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Comment

Gestion de comment

GET /comments

Affiche la liste des commentaires

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /comments/{comment}

Affiche un commentaire spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
comment *required string Yes Comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /comments

Crée un nouveau commentaire

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /comments/{comment}

Met à jour un commentaire existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
comment *required string Yes Comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "comment": "exemple_comment",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /comments/{comment}

Supprime un commentaire

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
comment *required string Yes Comment
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Configuration

Gestion de configuration

GET /configs

Affiche la liste des configurations

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /configs/{config}

Affiche une configuration spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
config *required string Yes Config
idOrName *required mixed Yes Id or name

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /configs

Crée une nouvelle configuration

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /configs/{config}

Met à jour une configuration existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
config *required string Yes Config
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "config": "exemple_config",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /configs/{config}

Supprime une configuration

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
config *required string Yes Config
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Contact

Gestion de contact

GET /contacts

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /contacts/{contact}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contact *required string Yes Contact
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /contacts

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /contacts/{contact}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contact *required string Yes Contact
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "contact": "exemple_contact",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /contacts/{contact}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
contact *required string Yes Contact
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Documentation

Gestion de documentation

GET //

Affiche la page d'accueil de la documentation

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Footer

Gestion de footer

GET /footers

Affiche la liste des footers

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /footers/{footer}

Affiche un footer spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
footer *required string Yes Footer
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /footers

Crée un nouveau footer

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /footers/{footer}

Met à jour un footer existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
footer *required string Yes Footer
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "footer": "exemple_footer",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /footers/{footer}

Supprime un footer

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
footer *required string Yes Footer
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Freelance

Gestion de freelance

GET /freelance-portfolio-items

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-portfolio-items/{freelance_portfolio_item}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_portfolio_item *required string Yes Freelance portfolio item
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-portfolio-items

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-portfolio-items/{freelance_portfolio_item}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_portfolio_item *required string Yes Freelance portfolio item
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_portfolio_item": "exemple_freelance_portfolio_item",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-portfolio-items/{freelance_portfolio_item}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_portfolio_item *required string Yes Freelance portfolio item
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-profiles

Liste tous les profils freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-profiles/{freelance_profile}

Affiche un profil freelance spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-profiles

Crée un nouveau profil freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-profiles/{freelance_profile}

Met à jour un profil freelance existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_profile": "exemple_freelance_profile",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-profiles/{freelance_profile}

Supprime un profil freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_profile *required string Yes Freelance profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-projects

Liste tous les projets freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-projects

Crée un nouveau projet freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-projects/{freelance_project}

Affiche un projet freelance spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project *required string Yes Freelance project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-projects/{freelance_project}

Met à jour un projet freelance existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project *required string Yes Freelance project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_project": "exemple_freelance_project",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-projects/{freelance_project}

Supprime un projet freelance

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project *required string Yes Freelance project
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-project-messages

Liste tous les messages de projet@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-project-messages

Crée un nouveau message de projet@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-project-messages/{freelance_project_message}

Affiche un message de projet spécifique@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_message *required string Yes Freelance project message
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-project-messages/{freelance_project_message}

Met à jour un message de projet existant@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_message *required string Yes Freelance project message
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_project_message": "exemple_freelance_project_message",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-project-messages/{freelance_project_message}

Supprime un message de projet@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_message *required string Yes Freelance project message
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-project-proposals

Liste toutes les propositions de projet@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-project-proposals

Crée une nouvelle proposition de projet@param Request $request@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-project-proposals/{freelance_project_proposal}

Affiche une proposition de projet spécifique@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_proposal *required string Yes Freelance project proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-project-proposals/{freelance_project_proposal}

Met à jour une proposition de projet existante@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_proposal *required string Yes Freelance project proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_project_proposal": "exemple_freelance_project_proposal",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-project-proposals/{freelance_project_proposal}

Supprime une proposition de projet@param Request $request@param int $id@return \Illuminate\Http\JsonResponse

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_project_proposal *required string Yes Freelance project proposal
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-users

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /freelance-users

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /freelance-users/{freelance_user}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_user *required string Yes Freelance user
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /freelance-users/{freelance_user}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_user *required string Yes Freelance user
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "freelance_user": "exemple_freelance_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /freelance-users/{freelance_user}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
freelance_user *required string Yes Freelance user
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Header

Gestion de header

GET /headers

Affiche la liste des headers

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /headers/{header}

Affiche un header spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
header *required string Yes Header
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /headers

Crée un nouveau header

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /headers/{header}

Met à jour un header existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
header *required string Yes Header
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "header": "exemple_header",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /headers/{header}

Supprime un header

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
header *required string Yes Header
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Health

Gestion de health

GET /health

Check

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Hook

Gestion de hook

GET /hooks

Affiche la liste des webhooks

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /hooks/{hook}

Affiche un webhook spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
hook *required string Yes Hook
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /hooks

Crée un nouveau webhook

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /hooks/{hook}

Met à jour un webhook existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
hook *required string Yes Hook
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "hook": "exemple_hook",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /hooks/{hook}

Supprime un webhook

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
hook *required string Yes Hook
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Html

Gestion de html

GET /htmls

Affiche la liste des contenus HTML

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /htmls/{html}

Affiche un contenu HTML spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
html *required string Yes Html
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /htmls

Crée un nouveau contenu HTML

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /htmls/{html}

Met à jour un contenu HTML existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
html *required string Yes Html
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "html": "exemple_html",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /htmls/{html}

Supprime un contenu HTML

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
html *required string Yes Html
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Menu

Gestion de menu

GET /menu-categories

Affiche la liste des catégories de menu

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /menu-categories/{menu_category}

Affiche une catégorie de menu spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu_category *required string Yes Menu category
idOrAlias *required mixed Yes Id or alias

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /menu-categories

Crée une nouvelle catégorie de menu

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /menu-categories/{menu_category}

Met à jour une catégorie de menu existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu_category *required string Yes Menu category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "menu_category": "exemple_menu_category",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /menu-categories/{menu_category}

Supprime une catégorie de menu

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu_category *required string Yes Menu category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /menus

Affiche la liste des menus

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /menus/{menu}

Affiche les menus d'une catégorie spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu *required string Yes Menu
categoryId *required mixed Yes Category id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /menus

Crée un nouveau menu

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /menus/{menu}

Met à jour un menu existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu *required string Yes Menu
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "menu": "exemple_menu",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /menus/{menu}

Supprime un menu

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
menu *required string Yes Menu
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Notification

Gestion de notification

GET /notification-subscriptions

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /notification-subscriptions/{notification_subscription}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_subscription *required string Yes Notification subscription
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /notification-subscriptions

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /notification-subscriptions/{notification_subscription}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_subscription *required string Yes Notification subscription
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "notification_subscription": "exemple_notification_subscription",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /notification-subscriptions/{notification_subscription}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_subscription *required string Yes Notification subscription
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /notification-templates

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /notification-templates/{notification_template}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_template *required string Yes Notification template
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /notification-templates

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /notification-templates/{notification_template}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_template *required string Yes Notification template
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "notification_template": "exemple_notification_template",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /notification-templates/{notification_template}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
notification_template *required string Yes Notification template
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /notification-templates/{id}/preview

Preview

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
id *required string Yes Id
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Package

Gestion de package

GET /packages

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /packages/{package}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package *required string Yes Package
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /packages

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /packages/{package}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package *required string Yes Package
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "package": "exemple_package",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /packages/{package}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package *required string Yes Package
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /package-features

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /package-features/{package_feature}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package_feature *required string Yes Package feature
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /package-features

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /package-features/{package_feature}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package_feature *required string Yes Package feature
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "package_feature": "exemple_package_feature",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /package-features/{package_feature}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
package_feature *required string Yes Package feature
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Page

Gestion de page

GET /pages

Affiche la liste des pages

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /pages/{page}

Affiche une page par son ID ou son slug

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
page *required string Yes Page
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /pages

Crée une nouvelle page

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /pages/{page}

Met à jour une page existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
page *required string Yes Page
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "page": "exemple_page",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /pages/{page}

Supprime une page

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
page *required string Yes Page
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Person

Gestion de person

GET /people

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /people/{person}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
person *required string Yes Person
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /people

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /people/{person}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
person *required string Yes Person
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "person": "exemple_person",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /people/{person}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
person *required string Yes Person
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Plan

Gestion de plan

GET /plans

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /plans/{plan}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
plan *required string Yes Plan
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /plans

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /plans/{plan}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
plan *required string Yes Plan
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "plan": "exemple_plan",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /plans/{plan}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
plan *required string Yes Plan
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Product

Gestion de product

GET /product-categories

Affiche la liste des catégories de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /product-categories

Crée une nouvelle catégorie de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-categories/{product_category}

Affiche une catégorie de produits spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_category *required string Yes Product category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /product-categories/{product_category}

Met à jour une catégorie de produits existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_category *required string Yes Product category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product_category": "exemple_product_category",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /product-categories/{product_category}

Supprime une catégorie de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_category *required string Yes Product category
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-colors

Affiche la liste des couleurs de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-colors/{product_color}

Affiche une couleur de produit spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_color *required string Yes Product color
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /product-colors

Crée une nouvelle couleur de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /product-colors/{product_color}

Met à jour une couleur de produit existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_color *required string Yes Product color
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product_color": "exemple_product_color",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /product-colors/{product_color}

Supprime une couleur de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_color *required string Yes Product color
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /products

Affiche la liste des produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /products

Crée un nouveau produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /products/{product}

Affiche un produit spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product *required string Yes Product
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /products/{product}

Met à jour un produit existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product *required string Yes Product
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product": "exemple_product",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /products/{product}

Supprime un produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product *required string Yes Product
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-sizes

Affiche la liste des tailles de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-sizes/{product_size}

Affiche une taille de produit spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_size *required string Yes Product size
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /product-sizes

Crée une nouvelle taille de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /product-sizes/{product_size}

Met à jour une taille de produit existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_size *required string Yes Product size
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product_size": "exemple_product_size",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /product-sizes/{product_size}

Supprime une taille de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_size *required string Yes Product size
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-stars

Affiche la liste des étoiles de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-stars/{product_star}

Affiche une étoile de produit spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_star *required string Yes Product star
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /product-stars

Crée une nouvelle étoile de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /product-stars/{product_star}

Met à jour une étoile de produit existante

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_star *required string Yes Product star
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product_star": "exemple_product_star",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /product-stars/{product_star}

Supprime une étoile de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_star *required string Yes Product star
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-tags

Affiche la liste des tags de produits

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /product-tags/{product_tag}

Affiche un tag de produit spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_tag *required string Yes Product tag
idOrSlug *required mixed Yes Id or slug

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /product-tags

Crée un nouveau tag de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /product-tags/{product_tag}

Met à jour un tag de produit existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_tag *required string Yes Product tag
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "product_tag": "exemple_product_tag",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /product-tags/{product_tag}

Supprime un tag de produit

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
product_tag *required string Yes Product tag
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Profile

Gestion de profile

GET /profiles

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /profiles/{profile}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
profile *required string Yes Profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /profiles

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /profiles/{profile}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
profile *required string Yes Profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "profile": "exemple_profile",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /profiles/{profile}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
profile *required string Yes Profile
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Role

Gestion de role

GET /roles

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /roles/{role}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
role *required string Yes Role
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /roles

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /roles/{role}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
role *required string Yes Role
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "role": "exemple_role",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /roles/{role}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
role *required string Yes Role
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Team

Gestion de team

GET /teams

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /teams/{team}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
team *required string Yes Team
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /teams

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /teams/{team}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
team *required string Yes Team
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "team": "exemple_team",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /teams/{team}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
team *required string Yes Team
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Testimonial

Gestion de testimonial

GET /testimonials

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /testimonials/{testimonial}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
testimonial *required string Yes Testimonial
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /testimonials

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /testimonials/{testimonial}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
testimonial *required string Yes Testimonial
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "testimonial": "exemple_testimonial",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /testimonials/{testimonial}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
testimonial *required string Yes Testimonial
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Utilisateurs

Gestion de utilisateurs

GET /users

Liste tous les éléments

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /login

Login

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /register

Register

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /users

Crée un nouvel élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /users/{user}

Affiche un élément spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

PUT /users/{user}

Met à jour un élément existant

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key",
    "user": "exemple_user",
    "id": "exemple_id"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource mise \u00e0 jour avec succ\u00e8s",
    "data": {
        "id": 1,
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /users/{user}

Supprime un élément

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
user *required string Yes User
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

Visitor

Gestion de visitor

GET /visitors

Affiche la liste des visiteurs

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Example 1",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            },
            {
                "id": 2,
                "name": "Example 2",
                "created_at": "2025-02-24T20:16:55+01:00",
                "updated_at": "2025-02-24T20:16:55+01:00"
            }
        ],
        "total": 2,
        "page": 1,
        "per_page": 10
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

GET /visitors/{visitor}

Affiche un visiteur spécifique

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
visitor *required string Yes Visitor
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "data": {
        "id": 1,
        "name": "Example",
        "description": "Description de l'exemple",
        "created_at": "2025-02-24T20:16:55+01:00",
        "updated_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

POST /visitors

Enregistre un nouveau visiteur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données

Request Example

Headers

Accept: application/json
Content-Type: application/json

Body

{
    "X-Api-Key": "exemple_X-Api-Key"
}

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource cr\u00e9\u00e9e avec succ\u00e8s",
    "data": {
        "id": 1,
        "created_at": "2025-02-24T20:16:55+01:00"
    }
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur

DELETE /visitors/{visitor}

Supprime un visiteur

Parameters

Name Type Required Description
X-Api-Key *required string Yes Clé API pour identifier la base de données
visitor *required string Yes Visitor
id *required mixed Yes Id

Request Example

Headers

Accept: application/json
Content-Type: application/json

Responses

200 Succès de la requête 

{
    "status": "success",
    "message": "Ressource supprim\u00e9e avec succ\u00e8s"
}

400 Requête invalide ou données manquantes 

{
    "status": "error",
    "message": "Une erreur est survenue",
    "errors": {
        "field": [
            "Message d'erreur d\u00e9taill\u00e9"
        ]
    }
}

401 Non autorisé - Clé API invalide ou manquante

403 Accès interdit - Permissions insuffisantes

404 Ressource non trouvée

500 Erreur interne du serveur