Uma empresa da
Cogna Educação

Documentação API

Método: GET

  • Endpoint: /api/integration/sales

Descrição

Esta rota permite recuperar uma lista paginada de vendas com base em vários parâmetros de filtro.

Parâmetros de Requisição

  • Header:

    • api-key (obrigatório): A chave de autenticação do usuário.
  • Query Parameters:

    • date_start (opcional): A data de início do intervalo de consulta.
    • date_end (opcional): A data de término do intervalo de consulta.
    • type (opcional): O tipo de intervalo de datas a ser filtrado (padrão: “paid_at”, “created_at”, “update_at” ).
    • status (opcional): O status da venda a ser filtrado. (“paid”, “refused”, “refunded”, “chargeback”)
    • method (opcional): O método de pagamento da venda a ser filtrado. (“CREDIT_CARD”, “BOLETO”, “PIX”, “PAYPAL”)
    • per_page (opcional): Número de itens por página na resposta (padrão: 10).

Resposta de Sucesso

  • Status Code: 200 OK
  • Formato da Resposta:
    json
    {
    "data": [
    {
    "id": 1,
    "client": {...},
    "product": {...},
    "proposal": {...},
    "status": "paid",
    "method": "credit_card",
    "created_at": "2023-01-01T12:34:56Z",
    "updated_at": "2023-01-02T10:00:00Z"
    },
    // ... Outras vendas
    ],
    "links": {...},
    "meta": {...}
    }

Resposta de Erro

  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Missing token authorization"
    }
  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Invalid token!"
    }

Exemplo de Chamada

bash
curl -X GET \
-H "api-key: YOUR_API_KEY" \
-d "date_start=2023-01-01" \
-d "date_end=2023-01-31" \
-d "type=created_at" \
-d "status=paid" \
-d "method=credit_card" \
-d "per_page=15" \
https://apiadm.voompcreators.com.br/api/integration/
sales

Lembre-se de substituir YOUR_API_KEY pelo valor correto da chave de autenticação.

Método: GET

  • Endpoint: /api/integration/sale/{id}

Descrição

Esta rota permite recuperar detalhes específicos de uma venda com base no ID da venda.

Parâmetros de Requisição

  • Header:

    • api-key (obrigatório): A chave de autenticação do usuário.
  • URI Parameters:

    • {id} (obrigatório): O ID único da venda da Voomp que deseja recuperar.

Resposta de Sucesso

  • Status Code: 200 OK
  • Formato da Resposta:
				
					{
  "id": 1,
  "client": {...},
  "product": {...},
  "proposal": {...},
  "status": "shipped",
  "method": "credit_card",
  "created_at": "2023-01-01T12:34:56Z",
  "updated_at": "2023-01-02T10:00:00Z"
}

				
			

Resposta de Erro

  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Missing token authorization"
    }
  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Invalid token!"
    }

Exemplo de Chamada

bash

curl -X GET \
-H "api-key: YOUR_API_KEY" \


https://apiadm.voompcreators.com.br/api/integration/sale/1

Lembre-se de substituir YOUR_API_KEY pelo valor correto da chave de autenticação.

Método: GET

Endpoint: /api/integration/product

Descrição: Esta rota permite recuperar uma lista paginada de produtos associados ao seller.

Parâmetros de Requisição:

  • Header:
    • api-key (obrigatório): A chave de autenticação do usuário.
 

Resposta de Sucesso:

  • Status Code: 200 OK
  • Formato da Resposta:
				
					{
  "data": [
    {
      "id": 1,
      "name": "Produto 1",
      "description": "Descrição do Produto 1",
      "preço": 19.99,
      "vendedor_id": 123,
      "status": "APROVADO",
      "data_criacao": "2023-01-01T12:34:56Z",
      "data_atualizacao": "2023-01-02T10:00:00Z"
    },
    // ... Outros produtos
  ]
}
				
			

Resposta de Erro

  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Missing token authorization"
    }
  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Invalid token!"
    }

Exemplo de Chamada

bash

curl -X GET \
-H "api-key: YOUR_API_KEY" \

https://apiadm.voompcreators.com.br/api/integration/product

Lembre-se de substituir YOUR_API_KEY pelo valor correto da chave de autenticação.

Método: GET

Endpoint: /api/integration/note

Descrição: Esta rota permite recuperar uma lista paginada de notas fiscais associados ao seller.

Parâmetros de Requisição:

  • Header:
    • api-key (obrigatório): A chave de autenticação do usuário.
  • Query Parameters:

    • date_start (opcional): Data de início para filtrar as notas. (Formato: YYYY-MM-DD)
    • date_end (opcional): Data de término para filtrar as notas. (Formato: YYYY-MM-DD)
    • method (opcional): Método de pagamento usado nas vendas.
    • per_page (opcional): Número de resultados por página na resposta.
 

Resposta de Sucesso:

  • Status Code: 200 OK
  • Formato da Resposta:
				
					{
  "data": [
    {
      "id": 1,
      "client": {
        "id": 123,
        "name": "Nome do Cliente",
        "email": "cliente@example.com",
        // ... outras informações do cliente
      },
      "product": {
        "id": 456,
        "name": "Nome do Produto",
        "description": "Descrição do Produto",
        // ... outras informações do produto
      },
      "proposal": {
        "id": 789,
        "name": "Nome da Proposta",
        "amount": 100.00,
        "description": "Descrição da Proposta",
        // ... outras informações da proposta
      },
      "status": "paid",
      "method": "credit_card",
      "created_at": "2023-01-01T12:34:56Z",
      "updated_at": "2023-01-02T10:00:00Z"
    },
    // ... outras vendas
  ]
}

				
			

Resposta de Erro

  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Missing token authorization"
    }
  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Invalid token!"
    }

Exemplo de Chamada

bash

curl -X GET \
-H "api-key: YOUR_API_KEY" \

https://apiadm.voompcreators.com.br/api/integration/note

Lembre-se de substituir YOUR_API_KEY pelo valor correto da chave de autenticação.

Método: GET

  • Endpoint: /api/integration/note/{id}

Descrição

Esta rota permite recuperar detalhes específicos de uma venda com base no ID da venda.

Parâmetros de Requisição

  • Header:

    • api-key (obrigatório): A chave de autenticação do usuário.
  • URI Parameters:

    • {id} (obrigatório): O ID único da venda da Voomp que deseja recuperar.

Resposta de Sucesso

  • Status Code: 200 OK
  • Formato da Resposta:
				
					{
  "data": [
    {
      "id": 1,
      "client": {
        "id": 123,
        "name": "Nome do Cliente",
        "email": "cliente@example.com",
        // ... outras informações do cliente
      },
      "product": {
        "id": 456,
        "name": "Nome do Produto",
        "description": "Descrição do Produto",
        // ... outras informações do produto
      },
      "proposal": {
        "id": 789,
        "name": "Nome da Proposta",
        "amount": 100.00,
        "description": "Descrição da Proposta",
        // ... outras informações da proposta
      },
      "status": "paid",
      "method": "credit_card",
      "created_at": "2023-01-01T12:34:56Z",
      "updated_at": "2023-01-02T10:00:00Z"
    },
    // ... outras vendas
  ]
}

				
			

Resposta de Erro

  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Missing token authorization"
    }
  • Status Code: 401 Unauthorized
  • Formato da Resposta:
    json
    {
    "error": "Invalid token!"
    }

Exemplo de Chamada

bash

curl -X GET \
-H "api-key: YOUR_API_KEY" \

https://apiadm.voompcreators.com.br/api/note/1

Lembre-se de substituir YOUR_API_KEY pelo valor correto da chave de autenticação.

Depoimento Ambiental Pro

Desde o início, tivemos uma excelente experiência e temos um contato muito próximo com os tomadores de decisão da plataforma. Eles sempre estão dispostos a ouvir nossas sugestões e implementá-las rapidamente, o que é realmente raro de se encontrar em outras plataformas.

 

Além disso, o atendimento da Voomp é simplesmente excepcional. Nunca tivemos um contato tão próximo e personalizado com outra plataforma, e isso tem sido fundamental para o sucesso de nossos cursos online. Eles estão sempre dispostos a ajudar e a resolver qualquer problema de maneira rápida e eficiente.

 

Outro ponto positivo da Voomp é a possibilidade de certificar nossos cursos pelo MEC, o que é muito valioso para nós e para nossos alunos. Isso mostra a seriedade e a qualidade da plataforma, e tem sido uma diferença fundamental na escolha da Voomp em relação a outras opções no mercado.

 

Em resumo, não poderíamos estar mais satisfeitos com a Voomp. Eles são uma equipe incrível e estão sempre procurando aprimorar a experiência dos usuários. Não hesitamos em recomendá-los a outras pessoas e em continuar trabalhando com eles no futuro.

Fale com o time Creators!