API Documentation Overview

1. Get Account Details

Endpoint: GET https://www.code.facefato.de/api/account/details

Description: Retrieves details of the account associated with the provided API key.

2. Get All Items

Endpoint: GET https://www.code.facefato.de/api/items/all

Description: Retrieves all items associated with the provided API key.

3. Get An Item Details

Endpoint: GET https://www.code.facefato.de/api/items/item

Description: Retrieves details of a specific item based on the provided item ID and API key.

4. Purchase Validation

Endpoint: POST https://www.code.facefato.de/api/purchases/validation

Description: Validate a purchase code and returns details about the purchase if valid.

Authentication

Navigate to Workspace Settings

The user should first log in to their account on the platform. Then, they can navigate to the "Settings" section of their workspace.

Locate API Key Section

Within the workspace settings, the user should look for a section specifically labeled "API Key" or "API Access."

Generate or Retrieve API Key

In this section, the user can either generate a new API key or retrieve an existing one if it has been previously generated. If there is an option to generate a new key, the user can click on it to create a fresh API key.

Copy the API Key

Once the API key is generated or retrieved, the user should be able to see it displayed on the screen. They can simply click on a button or icon next to the key to copy it to their clipboard.

Use the API Key

Wenn der API-Schlüssel kopiert wurde, kann der Benutzer ihn nun zur Authentifizierung seiner Anfragen beim Zugriff auf die API-Endpunkte der Plattform verwenden. In der Regel muss der API-Schlüssel je nach API-Authentifizierungsmechanismus als Teil der Anfrage-Header oder -Parameter angegeben werden.

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.

Get Account Details

Retrieves details of the account associated with the provided API key

Endpoint


            GET
https://www.code.facefato.de/api/account/details

Parameters

api_key: Your API key (Required)

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": "USD",
        "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"
}

Get All Items

Retrieves all items associated with the provided API key

This only works for authors and will not work for regular users.

Endpoint


            GET
https://www.code.facefato.de/api/items/all

Parameters

api_key: Your API key (Required)

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", // 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": [ // 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": "USD",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Error Response:


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

Get An Item Details

Retrieves details of a specific item based on the provided item ID and API key.

This only works for authors and will not work for regular users.

Endpoint


            GET
https://www.code.facefato.de/api/items/item

Parameters

api_key: Your API key (Required)
item_id: The ID of the item to retrieve (Required)

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", // 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": [ // 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": "USD",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Error Response:


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

Purchase Validation

Validate a purchase code and returns details about the purchase if valid.

This only works for authors and will not work for regular users.

Endpoint


            POST
https://www.code.facefato.de/api/purchases/validation

Parameters

api_key: Your API key (Required).
purchase_code: The purchase code to validate (Required).

Responses

Success Response:


            {
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regular",
            "price": 19.99,
            "currency": "USD",
            "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": [ 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": "USD",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "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"
        }
    }
}

Error Response:


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