Descripción general de la documentación de API

1. Obtener detalles de la cuenta

Endpoint: GET https://code.ra1nch3ck.cloud/api/account/details

Descripción: Recupera detalles de la cuenta asociada con la clave API proporcionada.

2. Obtener todos los artículos

Endpoint: GET https://code.ra1nch3ck.cloud/api/items/all

Descripción: Recupera todos los elementos asociados con la clave API proporcionada.

3. Obtenga detalles de un artículo

Endpoint: GET https://code.ra1nch3ck.cloud/api/items/item

Descripción: Recupera detalles de un elemento específico según el ID del elemento proporcionado y la clave API.

4. Validación de compra

Endpoint: POST https://code.ra1nch3ck.cloud/api/purchases/validation

Descripción: Valide un código de compra y devuelva detalles sobre la compra si es válido.

Authentication

Navegue hasta Configuración del espacio de trabajo

El usuario primero debe iniciar sesión en su cuenta en la plataforma. Luego, pueden navegar a la sección "Configuración" de su espacio de trabajo.

Locate API Key Section

Dentro de la configuración del espacio de trabajo, el usuario debe buscar una sección específicamente etiquetada como "Clave API" o "Acceso API"

Generar o recuperar clave API

En esta sección, el usuario puede generar una nueva clave API o recuperar una existente si se ha generado previamente. Si hay una opción para generar una nueva clave, el usuario puede hacer clic en ella para crear una nueva clave API.

Copy the API Key

Una vez generada o recuperada la clave API, el usuario debería poder verla mostrada en la pantalla. Simplemente pueden hacer clic en un botón o ícono al lado de la tecla para copiarlo a su portapapeles.

Use the API Key

Una vez copiada la clave de API, el usuario puede utilizarla para autenticar sus solicitudes al acceder a los endpoints de la API de la plataforma. Por lo general, la clave de API debe incluirse como parte de los encabezados de la solicitud o como parámetro, según el mecanismo de autenticación de la API.

Secure the API Key

Es fundamental recordar a los usuarios que mantengan sus claves de API seguras y que no las compartan públicamente. Deben evitar incluir claves de API directamente en el código del lado del cliente o compartirlas en repositorios de acceso público. En su lugar, se recomienda almacenar la clave de API de forma segura en aplicaciones del lado del servidor y utilizar controles de acceso adecuados.

Obtener detalles de la cuenta

Recupera detalles de la cuenta asociada con la clave API proporcionada

Endpoint


            GET
https://code.ra1nch3ck.cloud/api/account/details

Parametros

api_key: Tu clave API (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": "MXN",
        "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"
}

Obtener todos los artículos

Recupera todos los elementos asociados con la clave API proporcionada

Esto sólo funciona para autores y no funcionará para usuarios habituales.

Endpoint


            GET
https://code.ra1nch3ck.cloud/api/items/all

Parametros

api_key: Tu clave API (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", // Esto no está incluido para elementos de audio
                "preview_video": "https://example.com/video.mp4", // Esto solo está incluido para elementos de video
                "preview_audio": "https://example.com/audio.mp3", // Esto solo está incluido para elementos de audio
                "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": "MXN",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Error Response:


            {
    "status": "error",
    "msg": "No se encontraron artículos"
}

Obtenga detalles de un artículo

Recupera detalles de un elemento específico según el ID del elemento proporcionado y la clave API.

Esto sólo funciona para autores y no funcionará para usuarios habituales.

Endpoint


            GET
https://code.ra1nch3ck.cloud/api/items/item

Parametros

api_key: Tu clave API (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", // Esto no está incluido para elementos de audio
            "preview_video": "https://example.com/video.mp4", // Esto solo está incluido para elementos de video
            "preview_audio": "https://example.com/audio.mp3", // Esto solo está incluido para elementos de audio
            "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": "MXN",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Error Response:


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

Validación de compra

Valide un código de compra y devuelva detalles sobre la compra si es válido.

Esto sólo funciona para autores y no funcionará para usuarios habituales.

Endpoint


            POST
https://code.ra1nch3ck.cloud/api/purchases/validation

Parametros

api_key: Tu clave API (Required).
purchase_code: El código de compra a validar (Required).

Responses

Success Response:


            {
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regular",
            "price": 19.99,
            "currency": "MXN",
            "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", // Esto no está incluido para elementos de audio
                    "preview_video": "https://example.com/video.mp4", // Esto solo está incluido para elementos de video
                    "preview_audio": "https://example.com/audio.mp3", // Esto solo está incluido para elementos de audio
                    "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": "MXN",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // Esto no existirá si el soporte está deshabilitado o no es compatible
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:


            {
    "status": "error",
    "msg": "Código de compra no válido"
}