API-Dokumentationsübersicht

1. Kontodetails abrufen

Endpunkt: GET https://ricodo.de/api/account/details

Beschreibung: Ruft die Details des Kontos ab, das mit dem angegebenen API-Schlüssel verbunden ist.

2. Alle Artikel abrufen

Endpunkt: GET https://ricodo.de/api/items/all

Beschreibung: Ruft alle Artikel ab, die mit dem angegebenen API-Schlüssel verbunden sind.

3. Artikeldetails abrufen

Endpunkt: GET https://ricodo.de/api/items/item

Beschreibung: Ruft die Details eines bestimmten Artikels auf der Grundlage der angegebenen Artikelnummer und des API-Schlüssels ab.

4. Kaufbestätigung

Endpunkt: POST https://ricodo.de/api/purchases/validation

Beschreibung: Überprüft einen Kaufcode und gibt bei Gültigkeit die Details über den Kauf zurück.

Authentifizierung

Zu den Arbeitsbereichseinstellungen navigieren

Der Benutzer sollte sich zunächst bei seinem Konto auf der Plattform einloggen. Dann kann er zum Abschnitt „Einstellungen“ seines Arbeitsbereichs navigieren.

Locate API Key Section

Der Benutzer sollte in den Arbeitsbereichseinstellungen nach einem Abschnitt mit der Bezeichnung „API-Schlüssel“ oder „API-Zugang“ suchen.

API-Schlüssel generieren oder abrufen

Der Benutzer kann in diesem Abschnitt entweder einen neuen API-Schlüssel generieren oder einen bereits vorhandenen Schlüssel abrufen, wenn er zuvor generiert wurde. Wenn es eine Option zum Generieren eines neuen Schlüssels gibt, kann der Benutzer darauf klicken, um einen neuen API-Schlüssel zu erstellen.

API-Schlüssel kopieren

Wenn der API-Schlüssel generiert oder abgerufen wurde, sollte der Benutzer ihn auf dem Bildschirm sehen können. Er kann einfach auf eine Schaltfläche oder ein Symbol neben dem Schlüssel klicken, um ihn in seine Zwischenablage zu kopieren.

Use the API Key

Wenn Sie den API-Schlüssel kopiert haben, können Sie ihn nun zur Authentifizierung Ihrer Anfragen beim Zugriff auf die API-Endpunkte der Plattform verwenden. Je nach API-Authentifizierungsmechanismus muss er den API-Schlüssel in der Regel in die Header oder Parameter der Anfrage aufnehmen.

Secure the API Key

Its essential to remind users to keep their API keys secure and not share them publicly. They should avoid hardcoding API keys in client-side code or sharing them in publicly accessible repositories. Instead, they should consider storing the API key securely on their server-side applications and using appropriate access controls.

Kontodetails abrufen

Ruft die Details des Kontos ab, das mit dem angegebenen API-Schlüssel verbunden ist

Endpunkt


            GET
https://ricodo.de/api/account/details

Parameters

api_key: Ihr API-Schlüssel (Erforderlich)

Responses

Success Response:


            {
    "status": "success",
    "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"
    }
}

Error Response:


            {
    "status": "error",
    "msg": "Invalid request"
}

Alle Artikel abrufen

Retrieves all items associated with the provided API key

Dies funktioniert nur für Autoren und nicht für reguläre Benutzer.

Endpunkt


            GET
https://ricodo.de/api/items/all

Parameters

api_key: Ihr API-Schlüssel (Erforderlich)

Responses

Success Response:


            {
    "status": "success",
    "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", // Dies gilt nicht für Audioartikel
                "preview_video": "https://example.com/video.mp4", // Dies ist nur bei Videobeiträgen enthalten
                "preview_audio": "https://example.com/audio.mp3", // Dies ist nur bei Audiobeiträgen enthalten
                "screenshots": [ // Dies ist nur enthalten, wenn der Artikel Screenshots enthält
                    "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...
        }
    ]
}

Error Response:


            {
    "status": "error",
    "msg": "No items found"
}

Artikeldetails abrufen

Ruft die Details eines bestimmten Artikels auf der Grundlage der angegebenen Artikelnummer und des API-Schlüssels ab.

Dies funktioniert nur für Autoren und nicht für reguläre Benutzer.

Endpunkt


            GET
https://ricodo.de/api/items/item

Parameters

api_key: Ihr API-Schlüssel (Erforderlich)
item_id: The ID of the item to retrieve (Erforderlich)

Responses

Success Response:


            {
    "status": "success",
    "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", // Dies gilt nicht für Audioartikel
            "preview_video": "https://example.com/video.mp4", // Dies ist nur bei Videobeiträgen enthalten
            "preview_audio": "https://example.com/audio.mp3", // Dies ist nur bei Audiobeiträgen enthalten
            "screenshots": [ // Dies ist nur enthalten, wenn der Artikel Screenshots enthält
                "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"
    }
}

Error Response:


            {
    "status": "error",
    "msg": "Item Not Found"
}

Kaufbestätigung

Überprüft einen Kaufcode und gibt bei Gültigkeit die Details über den Kauf zurück.

Dies funktioniert nur für Autoren und nicht für reguläre Benutzer.

Endpunkt


            POST
https://ricodo.de/api/purchases/validation

Parameters

api_key: Ihr API-Schlüssel (Erforderlich).
purchase_code: The purchase code to validate (Erforderlich).

Responses

Success Response:


            {
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regulär",
            "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", // Dies gilt nicht für Audioartikel
                    "preview_video": "https://example.com/video.mp4", // Dies ist nur bei Videobeiträgen enthalten
                    "preview_audio": "https://example.com/audio.mp3", // Dies ist nur bei Audiobeiträgen enthalten
                    "screenshots": [ Dies ist nur enthalten, wenn der Artikel Screenshots enthält
                        "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", // Wenn die Unterstützung deaktiviert ist oder nicht unterstützt wird, ist dies nicht möglich
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:


            {
    "status": "error",
    "msg": "Invalid purchase code"
}