Obtener Categorías

Documentación del Endpoint: categorias

URL del Endpoint

GET https://site.com/api/categorias?apikey={apikey}

Parámetros de la Solicitud

La solicitud debe incluir los siguientes parámetros en la URL:

  • apikey (string, requerido): Tu clave API para autenticar la solicitud.

Ejemplo de Solicitud

GET https://site.com/api/categorias?apikey=your_api_key

Respuesta Exitosa

En caso de éxito, se devolverá un JSON con los detalles de las categorías.

Campos de Respuesta

  • success (boolean): Indica si la solicitud fue exitosa.

  • categories (array): Lista de categorías.

    • id (int): ID de la categoría.

    • slug (string): Slug de la categoría.

    • parent_id (int): ID de la categoría padre.

    • parent_tree (string): Árbol de categorías padre.

    • title_meta_tag (string): Meta título de la categoría.

    • description (string): Descripción de la categoría.

    • keywords (string): Palabras clave de la categoría.

    • category_order (int): Orden de la categoría.

    • featured_order (int): Orden destacado de la categoría.

    • homepage_order (int): Orden en la página principal.

    • visibility (int): Visibilidad de la categoría.

    • is_featured (int): Indica si la categoría es destacada.

    • show_on_main_menu (int): Indica si se muestra en el menú principal.

    • show_image_on_main_menu (int): Indica si se muestra la imagen en el menú principal.

    • show_products_on_index (int): Indica si se muestran los productos en el índice.

    • show_subcategory_products (int): Indica si se muestran productos de subcategorías.

    • storage (string): Tipo de almacenamiento de la imagen.

    • image (string): Ruta de la imagen de la categoría.

    • created_at (string): Fecha de creación de la categoría.

Ejemplo de Respuesta

{
    "success": true,
    "categories": [
        {
            "id": "1",
            "slug": "camaras",
            "parent_id": "0",
            "parent_tree": "",
            "title_meta_tag": "",
            "description": "",
            "keywords": "",
            "category_order": "1",
            "featured_order": "1",
            "homepage_order": "1",
            "visibility": "1",
            "is_featured": "1",
            "show_on_main_menu": "1",
            "show_image_on_main_menu": "1",
            "show_products_on_index": "1",
            "show_subcategory_products": "0",
            "storage": "local",
            "image": "uploads/category/category_66a98ead9946f2-02072780-99141594.jpg",
            "created_at": "2022-03-07 18:27:07"
        },
        {
            "id": "2",
            "slug": "juguetes-para-gato",
            "parent_id": "0",
            "parent_tree": "",
            "title_meta_tag": "",
            "description": "",
            "keywords": "",
            "category_order": "1",
            "featured_order": "1",
            "homepage_order": "5",
            "visibility": "1",
            "is_featured": "1",
            "show_on_main_menu": "1",
            "show_image_on_main_menu": "1",
            "show_products_on_index": "0",
            "show_subcategory_products": "0",
            "storage": "local",
            "image": "uploads/category/category_66a98ef48984f7-33210691-53803364.jpg",
            "created_at": "2022-03-14 16:50:59"
        },
        {
            "id": "3",
            "slug": "juegos-con-sonido",
            "parent_id": "2",
            "parent_tree": "2",
            "title_meta_tag": "",
            "description": "",
            "keywords": "",
            "category_order": "1",
            "featured_order": "1",
            "homepage_order": "5",
            "visibility": "1",
            "is_featured": "0",
            "show_on_main_menu": "1",
            "show_image_on_main_menu": "1",
            "show_products_on_index": "0",
            "show_subcategory_products": "0",
            "storage": "local",
            "image": "uploads/category/category_66a98ebf551cd4-97494608-76620767.jpg",
            "created_at": "2022-03-14 16:52:19"
        }
    ]
}

Respuesta de Error

En caso de error, se devolverá un JSON con un mensaje de error y un código de estado HTTP correspondiente.

Ejemplo de Respuesta de Error

{
    "error": "Invalid API Key"
}

Notas Adicionales

  • Autenticación: Asegúrate de que el API Key proporcionado sea válido.

  • Campos de la Categoría: Todos los campos de la categoría devueltos en la respuesta son solo para lectura.

Last updated