Resumen de la documentación de la API

1. Obtener detalles de la cuenta

Punto final: GET http://mapasymonografias.com/api/account/details

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

2. Obtener todos los artículos

Punto final: GET http://mapasymonografias.com/api/items/all

Descripción: Recupera todos los artículos asociados con la clave API proporcionada.

3. Obtener detalles de un artículo

Punto final: GET http://mapasymonografias.com/api/items/item

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

4. Validación de compra

Punto final: POST http://mapasymonografias.com/api/purchases/validation

Descripción: Valida un código de compra y devuelve detalles sobre la compra si es válida.

Autenticación

Navegar a la configuración del espacio de trabajo

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

Ubicar la sección de la clave API

Dentro de la configuración del espacio de trabajo, el usuario debe buscar una sección etiquetada específicamente 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 ya ha sido generada previamente. Si hay una opción para generar una nueva clave, el usuario puede hacer clic para crear una nueva clave API.

Copiar la clave API

Una vez que se haya generado o recuperado la clave API, el usuario debería poder verla en pantalla. Puede hacer clic en un botón o ícono junto a la clave para copiarla al portapapeles.

Usar la clave API

Con la clave API copiada, el usuario ahora puede usarla para autenticar sus solicitudes al acceder a los puntos finales de la API de la plataforma. Normalmente, debe incluir la clave API como parte de los encabezados o parámetros de la solicitud, dependiendo del mecanismo de autenticación de la API.

Asegurar la clave API

Es esencial recordar a los usuarios que mantengan sus claves API seguras y no las compartan públicamente. Deben evitar codificar claves API en código del lado del cliente o compartirlas en repositorios de acceso público. En su lugar, deben considerar almacenar la clave API de manera segura en sus aplicaciones del lado del servidor y usar controles de acceso apropiados.

Obtener detalles de la cuenta

Recupera detalles de la cuenta asociada con la clave API proporcionada

Punto final

GET
http://mapasymonografias.com/api/account/details

Parámetros

  • api_key: Tu clave API (Requerido)

Respuestas

Respuesta exitosa:

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

Respuesta de error:

{
    "status": "error",
    "msg": "Solicitud inválida"
}

Obtener todos los artículos

Recupera todos los artículos asociados con la clave API proporcionada

Punto final

GET
http://mapasymonografias.com/api/items/all

Parámetros

  • api_key: Tu clave API (Requerido)

Respuestas

Respuesta exitosa:

{
    "status": "éxito",
    "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 se incluye para artículos de audio
                "preview_video": "https://example.com/video.mp4", // Esto solo se incluye para artículos de video
                "preview_audio": "https://example.com/audio.mp3", // Esto solo se incluye para artículos de audio
                "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...
        }
    ]
}

Respuesta de error:

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

Obtener detalles de un artículo

Recupera detalles de un artículo específico según el ID del artículo y la clave API proporcionados.

Punto final

GET
http://mapasymonografias.com/api/items/item

Parámetros

  • api_key: Tu clave API (Requerido)
  • item_id: El ID del artículo para recuperar (Requerido)

Respuestas

Respuesta exitosa:

{
    "status": "éxito",
    "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 se incluye para artículos de audio
            "preview_video": "https://example.com/video.mp4", // Esto solo se incluye para artículos de video
            "preview_audio": "https://example.com/audio.mp3", // Esto solo se incluye para artículos de audio
            "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"
    }
}

Respuesta de error:

{
    "status": "error",
    "msg": "Artículo no encontrado"
}

Validación de compra

Valida un código de compra y devuelve detalles sobre la compra si es válida.

Punto final

POST
http://mapasymonografias.com/api/purchases/validation

Parámetros

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

Respuestas

Respuesta exitosa:

{
    "status": "éxito",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regular",
            "price": 19.99,
            "currency": "USD",
            "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", // Esto no existirá si el soporte está deshabilitado o no es compatible
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Respuesta de error:

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