Visão Geral da Documentação da API

1. Obter Detalhes da Conta

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

Descrição: Recupera detalhes da Conta Associada à Chave de API fornecida.

2. Obter Todos os Itens

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

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

3. Obter Detalhes do Item

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

Descrição: Recupere Detalhes de um Item específico com Base no ID do item e na Chave de API fornecidos.

4. Validação da Compra

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

Descrição: Valida um Código de Compra e retorna detalhes sobre a Compra, se válido.

Autenticação

Navegue até as Configurações do Espaço de Trabalho

O Usuário deve primeiro fazer Login em Sua Conta na Plataforma. Então, ele pode navegar até a seção "Configurações" de seu Espaço de Trabalho.

Localizar Seção de Chave de API

Nas configurações do Espaço de Trabalho, o Usuário deve procurar uma seção especificamente chamada "Chave de API" ou "Acesso de 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 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.

Copie a Chave da API

Uma vez que a Chave de API é gerada ou recuperada, o Usuário deve ser capaz de vê-la exibida na Tela. Eles podem simplesmente clicar em um botão ou ícone ao lado da Chave para copiá-la para sua Área de Transferência.

Use a Chave da API

Com a Chave de API copiada, o Usuário agora pode usá-la para autenticar suas solicitações ao acessar os endpoints da API da Plataforma. Eles normalmente precisam incluir a Chave de API como parte dos cabeçalhos ou Parâmetros da Solicitação, dependendo do Mecanismo de Autenticação da API.

Proteja a Chave da API

É essencial lembrar os Usuários para manter suas Chaves de API Seguras e não compartilhá-las publicamente. Eles devem evitar codificar Chaves de API em código do lado do Cliente ou compartilhá-las em repositórios acessíveis publicamente. Em vez disso, eles devem considerar armazenar a Chave de API com segurança em seus aplicativos do lado do servidor e usar controles de acesso apropriados.

Obter Detalhes da Conta

Recupera Detalhes da Conta associada à Chave de API fornecida

Endpoint

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

Parâmetros

  • api_key: Sua API key (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

Recupera todos os Itens Associados à Chave de API fornecida

Endpoint

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

Parâmetros

  • api_key: Sua API key (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 Itens de Áudio
                "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Itens de Vídeo
                "preview_audio": "https://example.com/audio.mp3", // Isso só está incluído para Itens de Áudio
                "screenshots": [ // Isso só será 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 Cncontrado"
}

Obter Detalhes do Item

Recupere Detalhes de um Item específico com Base no ID do item e na Chave de API fornecidos.

Endpoint

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

Parâmetros

  • api_key: Sua API key (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 está incluído para Itens de Áudio
            "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Itens de Vídeo
            "preview_audio": "https://example.com/audio.mp3", // Isso só está incluído para Itens de Áudio
            "screenshots": [ // Isso só será 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 da Compra

Valida um Código de Compra e retorna detalhes sobre a Compra, se válido.

Endpoint

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

Parâmetros

  • api_key: Sua API key (Obrigatório).
  • purchase_code: O Código de Compra para 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 está incluído para Itens de Áudio
                    "preview_video": "https://example.com/video.mp4", // Isso só está incluído para Itens de Vídeo
                    "preview_audio": "https://example.com/audio.mp3", // Isso só está incluído para Itens de Áudio
                    "screenshots": [ Isso só será 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 desabilitado 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"
}