Visão geral da documentação da API

1. Obtenha os detalhes da conta

Ponto final: PEGAR https://desapegocodes.com/api/account/details

Descrição: Recupera detalhes da conta associada à chave de API fornecida.

2. Obter todos os itens

Ponto final: PEGAR https://desapegocodes.com/api/items/all

Descrição: Recupera todos os itens associados à chave de API fornecida.

3. Obtenha detalhes do item

Ponto final: PEGAR https://desapegocodes.com/api/items/item

Descrição: Recupera detalhes de um item específico com base no ID do item e na chave da API fornecidos.

4. Validação da compra

Ponto final: PUBLICAR https://desapegocodes.com/api/purchases/validation

Descrição: Valida um código de compra e retorna detalhes sobre a compra, caso seja válida.

Autenticação

Acesse as Configurações do Espaço de Trabalho.

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.

Localize a seção da chave de API

Nas configurações do espaço de trabalho, o usuário deve procurar uma seção especificamente rotulada como "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 existente, caso já tenha sido gerada. Se houver a opção de gerar uma nova chave, o usuário pode clicar nela para criar uma nova chave de API.

Copie a chave API

Assim que a chave da API for gerada ou obtida, o usuário deverá vê-la exibida na tela. Ele poderá simplesmente clicar em um botão ou ícone ao lado da chave para copiá-la para a área de transferência.

Use a chave API

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

Proteja a chave API

É fundamental lembrar os usuários de manterem suas chaves de API em segurança e não compartilhá-las publicamente. Eles devem evitar inserir as chaves de API diretamente no código do cliente ou compartilhá-las em repositórios de acesso público. Em vez disso, devem considerar armazenar a chave de API com segurança em seus aplicativos do lado do servidor e usar controles de acesso apropriados.

Obtenha detalhes da conta

Recupera detalhes da conta associada à chave de API fornecida.

Ponto final

PEGAR
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"
}

Obtenha todos os itens

Recupera todos os itens associados à chave de API fornecida.

Ponto final

PEGAR
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"
}

Obtenha os detalhes de um item

Recupera detalhes de um item específico com base no ID do item e na chave da API fornecidos.

Ponto final

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

Parâmetros

  • api_key: Sua chave de API (Obrigatório)
  • item_id: O ID do item a ser recuperado (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 detalhes sobre a compra, caso seja válida.

Ponto final

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

Parâmetros

  • api_key: Sua chave de API (Obrigatório).
  • purchase_code: O código de compra a ser validado (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"
}