Aperçu de la documentation de l'API

1. Obtenir les détails du compte

Endpoint: GET https://frenchygeek.com/api/account/details

Description: Récupère les détails du compte associé à la clé API fournie.

2. Obtenez tous les articles

Endpoint: GET https://frenchygeek.com/api/items/all

Description: Récupère tous les éléments associés à la clé API fournie.

3. Obtenir les détails d'un article

Endpoint: GET https://frenchygeek.com/api/items/item

Description: Récupère les détails d'un élément spécifique en fonction de l'ID de l'élément et de la clé API fournis.

4. Validation de l'achat

Endpoint: POST https://frenchygeek.com/api/purchases/validation

Description: Validez un code d'achat et retournez les détails de l'achat s'il est valide.

Authentification

Accéder aux paramètres de l'espace de travail

L'utilisateur doit d'abord se connecter à son compte sur la plateforme. Ensuite, ils peuvent accéder à la section "Paramètres" de leur espace de travail.

Localiser la section de la clé API

Dans les paramètres de l'espace de travail, l'utilisateur doit rechercher une section spécifiquement intitulée "Clé API" ou "Accès API".

Générer ou Récupérer la clé API

Dans cette section, l'utilisateur peut soit générer une nouvelle clé API, soit en récupérer une existante si elle a déjà été générée. S'il y a une option pour générer une nouvelle clé, l'utilisateur peut cliquer dessus pour créer une nouvelle clé API.

Copier la clé API

Une fois la clé API générée ou récupérée, l'utilisateur devrait pouvoir la voir affichée à l'écran. Ils peuvent simplement cliquer sur un bouton ou une icône à côté de la touche pour la copier dans leur presse-papiers.

Utiliser la clé API

Avec la clé API copiée, l'utilisateur peut désormais l'utiliser pour authentifier ses demandes lors de l'accès aux points de terminaison de l'API de la plate-forme. Ils doivent généralement inclure la clé API dans le cadre des en-têtes ou des paramètres de la demande, en fonction du mécanisme d'authentification de l'API.

Sécurisez la clé API

Il est essentiel de rappeler aux utilisateurs de sécuriser leurs clés API et de ne pas les partager publiquement. Ils doivent éviter d'encoder en dur les clés API dans le code côté client ou de les partager dans des référentiels accessibles au public. Au lieu de cela, ils devraient envisager de stocker la clé API en toute sécurité sur leurs applications côté serveur et d'utiliser des contrôles d'accès appropriés.

Obtenir les détails du compte

Récupère les détails du compte associé à la clé API fournie

Endpoint

GET
https://frenchygeek.com/api/account/details

Paramètres

  • api_key: Votre clé API (Obligatoire)

Réponses

Réponse au succès:

{
    "status": "Succès",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "EUR",
        "profile": {
            "heading": "Profile Heading",
            "description": "Profile Description",
            "contact": {
                "email": "contact@example.com"
            },
            "social_links": [
                "facebook": "/",
                "x": "/",
                // etc...
            ],
            "media": {
                "avatar": "https://example.com/avatar.jpg",
                "cover": "https://example.com/cover.jpg"
            }
        },
        "registered_at": "2024-04-27T12:00:00Z"
    }
}

Réponse à l'erreur:

{
    "status": "Erreur",
    "msg": "Demande invalide"
}

Obtenir tous les articles

Récupère tous les éléments associés à la clé API fournie

Endpoint

GET
https://frenchygeek.com/api/items/all

Paramètres

  • api_key: Votre clé API (Obligatoire)

Réponses

Réponse au succès:

{
    "status": "Succès",
    "items": [
        {
            "id": 1,
            "name": "Sample Item",
            "description": "This is a sample item",
            "category": "Category Name",
            "sub_category": "Subcategory Name",
            "options": ["option1", "option2"],
            "version": 1.0.0,
            "demo_link": "https://example.com/demo",
            "tags": ["tag1", "tag2"],
            "media": {
                "thumbnail": "https://example.com/thumbnail.png",
                "preview_image": "https://example.com/preview.jpg", // Ceci n'est pas inclus pour les éléments audio
                "preview_video": "https://example.com/video.mp4", // Ceci n'est inclus que pour les articles vidéo
                "preview_audio": "https://example.com/audio.mp3", // Ceci n'est inclus que pour les éléments audio
                "screenshots": [ // Ceci n'est inclus que si l'article a des captures d'écran
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "EUR",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Réponse à l'erreur:

{
    "status": "Erreur",
    "msg": "Aucun article trouvé ;("
}

Obtenir les détails d'un article

Récupère les détails d'un élément spécifique en fonction de l'ID de l'élément et de la clé API fournis.

Endpoint

GET
https://frenchygeek.com/api/items/item

Paramètres

  • api_key: Votre clé API (Obligatoire)
  • item_id: L'identifiant de l'article à récupérer (Obligatoire)

Réponses

Réponse au succès:

{
    "status": "Succès",
    "item": {
        "id": 1,
        "name": "Sample Item",
        "description": "This is a sample item",
        "category": "Category Name",
        "sub_category": "Subcategory Name",
        "options": ["option1", "option2"],
        "version": 1.0.0,
        "demo_link": "https://example.com/demo",
        "tags": ["tag1", "tag2"],
        "media": {
            "thumbnail": "https://example.com/thumbnail.png",
            "preview_image": "https://example.com/preview.jpg", // Ceci n'est pas inclus pour les éléments audio
            "preview_video": "https://example.com/video.mp4", // Ceci n'est inclus que pour les articles vidéo
            "preview_audio": "https://example.com/audio.mp3", // Ceci n'est inclus que pour les éléments audio
            "screenshots": [ // Ceci n'est inclus que si l'article a des captures d'écran
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "EUR",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Réponse à l'erreur:

{
    "status": "Erreur",
    "msg": "Article non trouvé"
}

Validation de l'achat

Validez un code d'achat et retournez les détails de l'achat s'il est valide.

Endpoint

POST
https://frenchygeek.com/api/purchases/validation

Paramètres

  • api_key: Votre clé API (Obligatoire).
  • purchase_code: Le code d'achat à valider (Obligatoire).

Réponses

Réponse au succès:

{
    "status": "Succès",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Régulière",
            "price": 19.99,
            "currency": "EUR",
            "item": {
                "id": 1,
                "name": "Sample Item",
                "description": "This is a sample item",
                "category": "Category Name",
                "sub_category": "Subcategory Name",
                "options": ["option1", "option2"],
                "version": 1.0.0,
                "demo_link": "https://example.com/demo",
                "tags": ["tag1", "tag2"],
                "media": {
                    "thumbnail": "https://example.com/thumbnail.png",
                    "preview_image": "https://example.com/preview.jpg", // Ceci n'est pas inclus pour les éléments audio
                    "preview_video": "https://example.com/video.mp4", // Ceci n'est inclus que pour les articles vidéo
                    "preview_audio": "https://example.com/audio.mp3", // Ceci n'est inclus que pour les éléments audio
                    "screenshots": [ Ceci n'est inclus que si l'article a des captures d'écran
                        "https://example.com/screenshot1.jpg",
                        "https://example.com/screenshot2.jpg"
                    ],
                },
                "price": {
                    "regular": 19.99,
                    "extended": 29.99
                },
                "currency": "EUR",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // Cela n'existera pas si le support est désactivé ou non pris en charge
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Réponse à l'erreur:

{
    "status": "Erreur",
    "msg": "Code d'achat invalide"
}