Hotmart PHP SDK

Biblioteca criada para viabilizar de forma simples a utilização das funcionalidades da API da Hotmart em projetos em PHP.

É altamente recomendado acessar a documentação oficial da API da Hotmart antes de utilizar essa biblioteca.

Índice

• Instalação
• Testes
• Configuração
• API
  • Assinaturas
    • Obter assinaturas
    • Sumário de assinaturas
    • Compras de assinantes
    • Cancelar assinatura
    • Cancelar lista de assinaturas
    • Reativar assinatura
    • Reativar lista de assinaturas
    • Alterar dia da cobrança da assinatura
  • Transações (vendas)
    • Histórico de vendas
    • Sumário de vendas
    • Participantes de vendas
    • Comissões de vendas
    • Detalhamento de preços de vendas
    • Reembolso de venda
  • Área de membros
    • Obter módulos
    • Obter páginas de um módulo
    • Obter usuários
    • Obter progresso de um usuário

Instalação

Instale a biblioteca utilizando o comando

composer require joao-pedro-alves/hotmart-php-sdk

Testes

docker compose run php vendor/bin/phpunit

Configuração

Obtendo credenciais

Para iniciar a configuração da biblioteca é necessário antes obter as credenciais de acesso à API da Hotmart.

1. Acesse a área de Credenciais da Hotmart através da URL: https://app.hotmart.com/tools/credentials

2. Clique em "Criar credenciais"

3. Selecione "API Hotmart" e clique em "Criar credenciais"

4. Informe um nome para identificar essas credenciais, por exemplo "Aplicação Web" e prossiga clicando em "Criar credencial"

5. Salve as Chaves de acesso (Cliente ID, Client Secret e Basic), essas informações serão utilizadas para a configuração.

Configurando SDK

Instancie a classe de cliente da SDK passando como parâmetros os dados das credenciais obtidos no passo anterior

<?php
use Hotmart;

$hotmart = new Hotmart\Client(
    'a60ea46d-fd4a-48b6-a10b-823a9c3c1a35',
    '5e7ab2d7-6cd3-2da5-bc6b-45e10ab15021',
    'LTawYmU4NmQtZmQ0YS00OGI2LWGxMGItODkzYTljM2MxZTM1OjJlN7FhMmQ1LTZkZDctNJRmNS1iZTliLTk1ZTIwYmIxNTB1MX'
);

---

API

Funcionalidades suportadas pela API da Hotmart.

Todos os métodos aceitam os parâmetros informados na documentação do end-point correspondente, assim como também seu valor de retorno.

Assinaturas

Operações relacionadas a assinaturas.

Obter assinaturas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->get($paramsArray);

Ver documentação

Sumário de assinaturas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->summary($paramsArray);

Ver documentação

Compras de assinantes

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->purchases($subscriberCode, $paramsArray);

Ver documentação

Cancelar assinatura

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->cancel($subscriberCode, $paramsArray);

Ver documentação

Cancelar lista de assinaturas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->cancelList($subscriberCodeArray, $paramsArray);

Ver documentação

Reativar assinatura

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->reactivate($subscriberCode, $paramsArray);

Ver documentação

Reativar lista de assinaturas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->reactivateList($subscriberCodeArray, $paramsArray);

Ver documentação

Alterar dia da cobrança da assinatura

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->subscriptions()->changeChargeDay($subscriberCode, $paramsArray);

Ver documentação

Transações (vendas)

Operações relacionadas as vendas.

Histórico de vendas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->history($paramsArray);

Ver documentação

Sumário de vendas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->summary($paramsArray);

Ver documentação

Participantes de vendas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->participants($paramsArray);

Ver documentação

Comissões de vendas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->commissions($paramsArray);

Ver documentação

Detalhamento de preços de vendas

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->priceDetails($paramsArray);

Ver documentação

Reembolso de venda

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->transactions()->refund($transactionCode);

Ver documentação

Área de membros

Operações relacionadas as informações da área de membros.

Obter módulos

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->club()->modules('NOME_DO_SUBDOMINIO', $paramsArray);

Ver documentação

Obter páginas de um módulo

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->club()->modulePages($subDomain, $moduleId);

Ver documentação

Obter usuários

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->club()->users($subDomain);

Ver documentação

Obter progresso de um usuário

<?php
$hotmart = new Hotmart\Client('CLIENT_ID', 'CLIENT_SECRET', 'CLIENT_BASIC');
$hotmart->club()->userLessons($subDomain, $userId);

Ver documentação