API Dokumentation Übersicht

1. Kontodetails abrufen

Endpoint: GET https://meetpark.de/api/account/details

Beschreibung: Ruft Details des Kontos ab, das dem bereitgestellten API-Schlüssel zugeordnet ist.

2. Hole alle Produkte

Endpoint: GET https://meetpark.de/api/items/all

Beschreibung: Ruft alle mit dem bereitgestellten API-Schlüssel verknüpften Produkte ab.

3. Produkt-Details

Endpoint: GET https://meetpark.de/api/items/item

Beschreibung: Ruft Details eines bestimmten Artikels basierend auf der bereitgestellten Produkt-ID und dem API-Schlüssel ab.

4. Kaufbestätigung

Endpoint: POST https://meetpark.de/api/purchases/validation

Beschreibung: Validiert einen Kaufcode und gibt Details zum Kauf zurück, sofern gültig.

Authentifizierung

Navigieren zu den Abeitsbereich-Einstellungen

Der Benutzer muss sich zuerst in sein Konto einloggen. Dann kann er zum "Einstellungen"-Bereich seines Arbeitsbereiches navigieren.

Locate API Key Section

In den Arbeitsbereichseinstellungen sollte der Benutzer nach einem Abschnitt suchen, der speziell mit „API-Schlüssel“ oder „API-Zugriff“ gekennzeichnet ist.

API Key generieren oder anfordern

In diesem Abschnitt kann der Benutzer entweder einen neuen API-Schlüssel generieren oder einen vorhandenen abrufen, wenn dieser 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 Key kopieren

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

API Key benutzen

Nachdem der API-Schlüssel kopiert wurde, kann der Benutzer ihn nun zur Authentifizierung seiner Anforderungen verwenden, wenn er auf die Plattform-API-Endpunkte zugreift. Abhängig vom API-Authentifizierungsmechanismus müssen sie in der Regel den API-Schlüssel als Teil der Anforderungsheader oder -parameter einschließen.

API Key sichern

Es ist wichtig, Benutzer daran zu erinnern, ihre API-Schlüssel sicher aufzubewahren und sie nicht öffentlich weiterzugeben. Sie sollten es vermeiden, API-Schlüssel im clientseitigen Code fest zu codieren oder sie in öffentlich zugänglichen Repositorys zu teilen. Stattdessen sollten sie erwägen, den API-Schlüssel sicher in ihren serverseitigen Anwendungen zu speichern und geeignete Zugriffskontrollen zu verwenden.

Kontodetails abrufen

Ruft Details des Kontos ab, das dem bereitgestellten API-Schlüssel zugeordnet ist

Endpoint

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

Parameter

  • api_key: Ihr API key (Erforderlich)

Antworten

Erfolgsantwort:

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

Fehlermeldung:

{
    "status": "Fehler",
    "msg": "Ungültige Anfrage"
}

Hole alle Produkte

Ruft alle mit dem bereitgestellten API-Schlüssel verknüpften Produkte ab

Endpoint

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

Parameter

  • api_key: Ihr API key (Erforderlich)

Antworten

Erfolgsantwort:

{
    "status": "Erfolg",
    "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 ist nicht für Audioartikel enthalten
                "preview_video": "https://example.com/video.mp4", // Dies ist nur für Videoartikel enthalten
                "preview_audio": "https://example.com/audio.mp3", // Dies ist nur für Audioartikel enthalten
                "screenshots": [ // This is only included if item has screenshots
                    "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...
        }
    ]
}

Fehlermeldung:

{
    "status": "Fehler",
    "msg": "Keine Produkte gefunden"
}

Artikeldetails holen

Ruft Details eines bestimmten Artikels basierend auf der bereitgestellten Produkt-ID und dem API-Schlüssel ab.

Endpoint

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

Parameter

  • api_key: Ihr API key (Erforderlich)
  • item_id: Die ID des abzurufenden Artikels (Erforderlich)

Antworten

Erfolgsantwort:

{
    "status": "Erfolg",
    "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 ist nicht für Audioartikel enthalten
            "preview_video": "https://example.com/video.mp4", // Dies ist nur für Videoartikel enthalten
            "preview_audio": "https://example.com/audio.mp3", // Dies ist nur für Audioartikel enthalten
            "screenshots": [ // This is only included if item has screenshots
                "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"
    }
}

Fehlermeldung:

{
    "status": "Fehler",
    "msg": "Artikel nicht gefunden"
}

Kaufbestätigung

Validiert einen Kaufcode und gibt Details zum Kauf zurück, sofern gültig.

Endpoint

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

Parameter

  • api_key: Ihr API key (Erforderlich).
  • purchase_code: Der zu validierende Kaufcode (Erforderlich).

Antworten

Erfolgsantwort:

{
    "status": "Erfolg",
    "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 ist nicht für Audioartikel enthalten
                    "preview_video": "https://example.com/video.mp4", // Dies ist nur für Videoartikel enthalten
                    "preview_audio": "https://example.com/audio.mp3", // Dies ist nur für Audioartikel enthalten
                    "screenshots": [ This is only included if item has screenshots
                        "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", // Dies ist nicht vorhanden, wenn der Support deaktiviert ist oder nicht unterstützt wird
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Fehlermeldung:

{
    "status": "Fehler",
    "msg": "Ungültiger Kaufcode"
}