Présentation de la documentation de l'API

1. Obtenir les détails du compte

Point de terminaison: OBTENIR https://store.yigui-serveur.com/api/account/details

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

2. Obtenir tous les éléments

Point de terminaison: OBTENIR https://store.yigui-serveur.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

Point de terminaison: OBTENIR https://store.yigui-serveur.com/api/items/item

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

4. Validation de l'achat

Point de terminaison: POST https://store.yigui-serveur.com/api/purchases/validation

Description: Valider un code d'achat et renvoyer 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 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 une 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 existe une option permettant de générer une nouvelle clé, l'utilisateur peut cliquer dessus pour créer une nouvelle clé API.

Copiez la clé API

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

Utiliser la clé API

Une fois la clé API copiée, l'utilisateur peut désormais l'utiliser pour authentifier ses requêtes lors de l'accès aux points de terminaison API de la plateforme. Ils doivent généralement inclure la clé API dans les en-têtes ou les paramètres de la requête, en fonction du mécanisme d'authentification de l'API.

Sécuriser la clé API

Il est essentiel de rappeler aux utilisateurs de conserver leurs clés API en sécurité et de ne pas les partager publiquement. Ils doivent éviter de coder 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 doivent 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

Point de terminaison

OBTENIR
https://store.yigui-serveur.com/api/account/details

Paramètres

  • api_key: Votre clé API (Obligatoire)

Réponses

Réponse de réussite:

{
    "status": "succès",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "GNF",
        "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 d'erreur:

{
    "status": "erreur",
    "msg": "Demande non valide"
}

Obtenir tous les articles

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

Point de terminaison

OBTENIR
https://store.yigui-serveur.com/api/items/all

Paramètres

  • api_key: Votre clé API (Obligatoire)

Réponses

Réponse de réussite:

{
    "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", // This is not included for audio items
                "preview_video": "https://example.com/video.mp4", // This is only included for video items
                "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                "screenshots": [
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "GNF",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Réponse d'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 d'élément et de la clé API fournis.

Point de terminaison

OBTENIR
https://store.yigui-serveur.com/api/items/item

Paramètres

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

Réponses

Réponse de réussite:

{
    "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", // This is not included for audio items
            "preview_video": "https://example.com/video.mp4", // This is only included for video items
            "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
            "screenshots": [
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "GNF",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Réponse d'erreur:

{
    "status": "erreur",
    "msg": "Élément non trouvé"
}

Validation d'achat

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

Point de terminaison

POST
https://store.yigui-serveur.com/api/purchases/validation

Paramètres

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

Réponses

Réponse de réussite:

{
    "status": "succès",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Régulier",
            "price": 19.99,
            "currency": "GNF",
            "item": {
                "id": 1,
                "name": "Sample Item",
                "url": "https://example.com/item",
                "media": {
                    "preview_image": "https://example.com/preview.jpg"
                }
            },
            "supported_until": "2024-04-27T12:00:00Z", // This will not exist if support is disabled or its not supported
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Réponse d'erreur:

{
    "status": "erreur",
    "msg": "Code d'achat non valide"
}