API Documentation Overview

1. Obter detalhes da conta

Endpoint: GET https://store.peep.company/api/account/details

Description: Recupera os detalhes da conta associada à chave da API fornecida.

2. Get All Items

Endpoint: GET https://store.peep.company/api/items/all

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

3. Get An Item Details

Endpoint: GET https://store.peep.company/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://store.peep.company/api/purchases/validation

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

Authentication

Navegar para as Configurações do Espaço de Trabalho

O usuário deve primeiro fazer login na sua conta na plataforma. Em seguida, ele pode navegar até a seção "Configurações" do seu espaço de trabalho.

Locate API Key Section

Dentro das configurações do espaço de trabalho, o usuário deve procurar uma seção especificamente rotulada como "Chave da API" ou "Acesso à API."

Generate or Retrieve API Key

Nesta seção, o usuário pode gerar uma nova chave da API ou recuperar uma existente, caso tenha sido gerada anteriormente. Se houver uma opção para gerar uma nova chave, o usuário pode clicar nela para criar uma nova chave da API.

Copy the API Key

Depois que a chave da API for gerada ou recuperada, o usuário deve ser capaz de vê-la exibida na tela. Ele pode simplesmente clicar em um botão ou ícone ao lado da chave para copiá-la para a área de transferência.

Use the API Key

Com a chave da API copiada, o usuário pode usá-la agora para autenticar suas requisições ao acessar os pontos finais da API da plataforma. Normalmente, é necessário incluir a chave da API como parte dos cabeçalhos ou parâmetros da requisição, dependendo do mecanismo de autenticação da API.

Secure the API Key

É essencial lembrar os usuários de manter suas chaves da API seguras e não compartilhá-las publicamente. Eles devem evitar codificar as chaves da API diretamente no código do lado do cliente ou compartilhá-las em repositórios públicos acessíveis. Em vez disso, devem considerar armazenar a chave da API de forma segura em suas aplicações no lado do servidor e usar controles de acesso apropriados.

Obter detalhes da conta

Recupera os detalhes da conta associada à chave da API fornecida

Endpoint

GET
https://store.peep.company/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": "BRL",
        "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

Endpoint

GET
https://store.peep.company/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", // Isso não está incluído para itens de áudio
                "preview_video": "https://example.com/video.mp4", // Isso só é incluído para itens de vídeo
                "preview_audio": "https://example.com/audio.mp3", // Isso só é incluído para itens de áudio
                "screenshots": [ // Isso só é incluído se o item tiver capturas de tela
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "BRL",
            "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.

Endpoint

GET
https://store.peep.company/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", // Isso não está incluído para itens de áudio
            "preview_video": "https://example.com/video.mp4", // Isso só é incluído para itens de vídeo
            "preview_audio": "https://example.com/audio.mp3", // Isso só é incluído para itens de áudio
            "screenshots": [ // Isso só é incluído se o item tiver capturas de tela
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "BRL",
        "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.

Endpoint

POST
https://store.peep.company/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": "BRL",
            "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", // Isso não está incluído para itens de áudio
                    "preview_video": "https://example.com/video.mp4", // Isso só é incluído para itens de vídeo
                    "preview_audio": "https://example.com/audio.mp3", // Isso só é incluído para itens de áudio
                    "screenshots": [ Isso só é incluído se o item tiver capturas de tela
                        "https://example.com/screenshot1.jpg",
                        "https://example.com/screenshot2.jpg"
                    ],
                },
                "price": {
                    "regular": 19.99,
                    "extended": 29.99
                },
                "currency": "BRL",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // Isso não existirá se o suporte estiver desativado ou não for compatível.
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:

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