Layout próprio

Por conta da nossa API desacoplada, é possível hospedar seu próprio layout e consumir nossa API de forma gratuita.

A autenticação da loja é feita pelo x-hydrus-domain, este cabeçalho indica de qual loja virá a informação.

Domínio para integração: https://api.hydrus.gg

---

Obter informações gerais da loja

GET /shopping

Esta rota retorna todos os dados básicos de uma loja, incluindo nome, categorias, variáveis

Headers

Name	Value
x-hydrus-domain	{store.domain}

Response

200

{
    "name": "Loja Exemplo",
    "variables": [
        {
            "id": 1,
            "name": "Discord",
            "type": "discord"
        },
        {
            "id": 2,
            "name": "User ID",
            "type": "user_id"
        }
    ],
    "categories": [
        {
            "id": 1,
            "store_id": 1,
            "name": "VIPS",
            "enabled": true,
            "page_size": 20,
            "weight": 3201,
            "deleted_at": null,
            "created_at": "2023-01-13T01:16:29.000000Z",
            "updated_at": "2024-02-02T23:48:17.000000Z",
            "visible": true,
            "packages_count": 14
        }
    ],
    "layout": {
        "theme": "darkocean",
        "logo": "https://storage.hydrus.gg/production/static/placeholder.png",
        "banner": "https://storage.hydrus.gg/production/static/placeholder.png",
        "icon": "https://storage.hydrus.gg/production/static/placeholder.png",
        "created_at": "2023-01-13T01:16:28.000000Z",
        "updated_at": "2024-03-31T02:56:58.000000Z",
        "body": "https://storage.hydrus.gg/production/static/placeholder.html",
        "styles_url": "https://storage.hydrus.gg/production/static/placeholder.css"
    },
    "currency": "BRL",
    "country": "BR",
    "terms_of_service": "https://storage.hydrus.gg/production/static/placeholder.txt",
    "require_address": false
}

404

{
  "message": "Entity Store not found"
}

Paginação de Produtos

GET /shopping/categories/{categoryId}/packages

Esta rota retorna os produtos de uma categoria na página especificada.

Headers

Name	Value
x-hydrus-domain	{store.domain}

Search Params

Name	Type	Description
page	number	Página

Response

200

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "Produto Exemplo",
            "price": 29.99,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse rhoncus diam nulla",
            // stock null indica um produto infinito
            // stock 0 indica que o estoque acabou
            "stock": null,
            "weight": 1,
            "images": [
                {
                    "id": 1,
                    "url": "https://storage.hydrus.gg/production/packages/placeholder.png"
                }
            ]
        }
    ],
    "first_page_url": "http://api.hydrus.gg/shopping/categories/1/packages?page=1",
    "from": 1,
    "to": 1,
    "last_page": 1,
    "last_page_url": "http://api.hydrus.gg/shopping/categories/1/packages?page=1",
    "links": [
        {
            "url": null,
            "label": "« Anterior",
            "active": false
        },
        {
            "url": "http://api.hydrus.gg/shopping/categories/1/packages?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Próximo »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "http://api.hydrus.gg/shopping/categories/1/packages",
    "per_page": 20,
    "prev_page_url": null,
    "total": 1
}

404

{
  "error": "Entity Category not found"
}

Busca de produtos

GET /shopping/packages/search

Esta rota busca produtos utilizando palavras chaves como indexação

Headers

Name	Value
x-hydrus-domain	{store.domain}

Search Params

Name	Type	Description
name	string	Nome do produto
page	number	Página

Response

200

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "Produto Exemplo",
            "price": 29.99,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse rhoncus diam nulla",
            // stock null indica um produto infinito
            // stock 0 indica que o estoque acabou
            "stock": null,
            "weight": 1,
            "images": [
                {
                    "id": 1,
                    "url": "https://storage.hydrus.gg/production/packages/placeholder.png"
                }
            ]
        }
    ],
    "first_page_url": "http://api.hydrus.gg/shopping/packages/search?page=1",
    "from": 1,
    "to": 1,
    "last_page": 1,
    "last_page_url": "http://api.hydrus.gg/shopping/packages/search?page=1",
    "links": [
        {
            "url": null,
            "label": "« Anterior",
            "active": false
        },
        {
            "url": "http://api.hydrus.gg/shopping/packages/search?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Próximo »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "http://api.hydrus.gg/shopping/packages/search",
    "per_page": 20,
    "prev_page_url": null,
    "total": 1
}

404

{
  "message": "Entity Store not found"
}

Para realizar checkout, utilize o guia em Fast Checkout