Visão Geral da documentação da API

1. Obter Detalhes da Conta

Endpoint: OBTER https://www.divulgaae.com.br/api/account/details

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

2. Obter Todos Produtos

Endpoint: OBTER https://www.divulgaae.com.br/api/produtos/all

Descrição: Recupera todos Produtos Associados com o fornecido chave de API.

3. Obter Um Detalhes de um Produto

Endpoint: OBTER https://www.divulgaae.com.br/api/produtos/item

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

4. Compra Validação

Endpoint: POST https://www.divulgaae.com.br/api/purchases/validation

Descrição: Validate um código de compra e returns detalhes sobre o compra if válido.

Autenticação

Navegue até as Configurações do Workspace

O usuário deve primeiro fazer login em sua conta na plataforma. Em seguida, 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 denominada "API Key" ou "API Access".

Gerar ou recuperar a chave de API

Nesta seção, o usuário pode gerar uma nova chave de API ou recuperar uma existente, caso ela 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 de API.

Copiar a chave de API

Assim que a chave da API for gerada ou recuperada, o usuário deverá 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.

Usar a chave de API

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

Proteger a chave de API

É fundamental lembrar os usuários de manterem suas chaves de API seguras e de não as compartilharem publicamente. Eles devem evitar incorporar chaves de API diretamente no código do lado do cliente ou compartilhá-las em repositórios de acesso público. Em vez disso, devem considerar armazenar a chave de API de forma segura em suas aplicações do lado do servidor e utilizar controles de acesso adequados.

Obter detalhes da conta

conta associada à chave de API fornecida

Endpoint

OBTER
https://www.divulgaae.com.br/api/account/details

Parâmetros

  • api_key: Seu 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 Produtos

Recupera todos os Produtos associados à chave de API fornecida.

Endpoint

OBTER
https://www.divulgaae.com.br/api/produtos/all

Parâmetros

  • api_key: Seu 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 está incluído para Produtos de áudio.
                "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Produtos de Vídeo.
                "preview_audio": "https://example.com/audio.mp3", // Isso está Incluído apenas para Produtos de áudio.
                "screenshots": [ // Isso só é Incluído se o Produto tiver Previews
                    "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 Produto Encontrado"
}

Obter Detalhes de um Produto

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

Endpoint

OBTER
https://www.divulgaae.com.br/api/produtos/item

Parâmetros

  • api_key: Seu chave de API (Obrigatório)
  • item_id: O ID de o item para Recuperar (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 está incluído para Produtos de áudio.
            "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Produtos de Vídeo.
            "preview_audio": "https://example.com/audio.mp3", // Isso está Incluído apenas para Produtos de áudio.
            "screenshots": [ // Isso só é Incluído se o Produto tiver Previews
                "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": "Produto não encontrado"
}

Validação da Dompra

Validate um código de compra e returns detalhes sobre o compra if válido.

Endpoint

POST
https://www.divulgaae.com.br/api/purchases/validation

Parâmetros

  • api_key: Seu chave de API (Obrigatório).
  • purchase_code: O código de compra para validate (Obrigatório).

Respostas

Resposta de Sucesso:

{
    "status": "Sucesso",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Produto Digital",
            "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 Produtos de áudio.
                    "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Produtos de Vídeo.
                    "preview_audio": "https://example.com/audio.mp3", // Isso está Incluído apenas para Produtos de áudio.
                    "screenshots": [ Isso só é Incluído se o Produto tiver Previews
                        "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 suportado.
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Resposta de erro:

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