Visão geral da documentação da API

1. Get Dados da conta

Endpoint: GET https://desapegocodes.com/api/account/details

Descrição: Retorna os detalhes da conta associada à chave de API informada.

2. Get All Itens

Endpoint: GET https://desapegocodes.com/api/items/all

Descrição: Retorna todos os itens associados à chave de API informada.

3. Get An Item Detalhes

Endpoint: GET https://desapegocodes.com/api/items/item

Descrição: Retorna os detalhes de um item específico com base no ID do item e na chave de API informados.

4. Validação de compra

Endpoint: POST https://desapegocodes.com/api/purchases/validation

Descrição: Valida um código de compra e retorna os detalhes da compra se for válido.

Autenticação

Navigate to Área de trabalho Configurações

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

Localizar a seção da chave de API

Nas configurações da área de trabalho, o usuário deve procurar a seção chamada \"Chave de API\" ou \"Acesso à API\".

Gerar ou recuperar chave de API

Nesta seção, o usuário pode gerar uma nova chave de API ou recuperar uma chave existente, se ela já tiver sido gerada. Se houver a opção de gerar uma nova chave, basta clicar nela.

Copiar a chave de API

Depois que a chave de API for gerada ou recuperada, ela será exibida na tela. O usuário pode clicar no botão ou ícone ao lado da chave para copiá-la.

Usar a chave de API

Com a chave de API copiada, o usuário pode autenticar suas requisições ao acessar os endpoints da API da plataforma. Normalmente, a chave deve ser incluída nos cabeçalhos ou parâmetros da requisição.

Proteger a chave de API

É essencial lembrar os usuários de manter suas chaves de API seguras e não compartilhá-las publicamente. Evite inserir chaves diretamente no código do cliente ou em repositórios públicos; armazene-as no servidor com controles de acesso adequados.

Obter dados da conta

Retorna os detalhes da conta associada à chave de API informada

Endpoint

GET
https://desapegocodes.com/api/account/details

Parâmetros

  • api_key: Sua chave de API (Obrigatório)

Respostas

Resposta de sucesso:

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

Resposta de erro:

{
    "status": "erro",
    "msg": "Solicitação inválida"
}

Obter todos os itens

Retorna todos os itens associados à chave de API informada

Endpoint

GET
https://desapegocodes.com/api/items/all

Parâmetros

  • api_key: Sua chave de API (Obrigatório)

Respostas

Resposta de sucesso:

{
    "status": "sucesso",
    "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 se aplica a itens de áudio.
                "preview_video": "https://example.com/video.mp4", // Isso só se aplica a itens de vídeo.
                "preview_audio": "https://example.com/audio.mp3", // Isso só se aplica a itens de áudio.
                "screenshots": [ // Isso só está 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...
        }
    ]
}

Resposta de erro:

{
    "status": "erro",
    "msg": "Nenhum item encontrado"
}

Obter detalhes de um item

Retorna os detalhes de um item específico com base no ID do item e na chave de API informados.

Endpoint

GET
https://desapegocodes.com/api/items/item

Parâmetros

  • api_key: Sua chave de API (Obrigatório)
  • item_id: O ID do item a ser retornado (Obrigatório)

Respostas

Resposta de sucesso:

{
    "status": "sucesso",
    "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 se aplica a itens de áudio.
            "preview_video": "https://example.com/video.mp4", // Isso só se aplica a itens de vídeo.
            "preview_audio": "https://example.com/audio.mp3", // Isso só se aplica a itens de áudio.
            "screenshots": [ // Isso só está 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"
    }
}

Resposta de erro:

{
    "status": "erro",
    "msg": "Item não encontrado"
}

Validação de compra

Valida um código de compra e retorna os detalhes da compra se for válido.

Endpoint

POST
https://desapegocodes.com/api/purchases/validation

Parâmetros

  • api_key: Sua chave de API (Obrigatório).
  • purchase_code: O código de compra a validar (Obrigatório).

Respostas

Resposta de sucesso:

{
    "status": "sucesso",
    "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 se aplica a itens de áudio.
                    "preview_video": "https://example.com/video.mp4", // Isso só se aplica a itens de vídeo.
                    "preview_audio": "https://example.com/audio.mp3", // Isso só se aplica a itens de áudio.
                    "screenshots": [ Isso só está 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"
        }
    }
}

Resposta de erro:

{
    "status": "erro",
    "msg": "Código de compra inválido"
}