README

创建的库，旨在简化PHP项目中使用Hotmart API的功能。

强烈建议在开始使用此库之前访问Hotmart API官方文档。

目录

• 安装
• 测试
• 配置
• API
  • 订阅
    • 获取订阅
    • 订阅摘要
    • 订阅者购买
    • 取消订阅
    • 取消订阅列表
    • 恢复订阅
    • 恢复订阅列表
    • 更改订阅收费日
  • 交易（销售）
    • 销售历史
    • 销售摘要
    • 销售参与者
    • 销售佣金
    • 销售价格详情
    • 销售退款
  • 会员区
    • 获取模块
    • 获取模块页面
    • 获取用户
    • 获取用户进度

安装

使用以下命令安装库

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

测试

docker compose run php vendor/bin/phpunit

配置

获取凭证

为了开始配置库，首先需要获取访问Hotmart API的凭证。

1. 通过以下URL访问Hotmart凭证区域： https://app.hotmart.com/tools/credentials

2. 点击 "创建凭证"

3. 选择 "Hotmart API" 并点击 "创建凭证"

4. 为这些凭证输入一个名称，例如 "Web应用程序"，然后继续点击 "创建凭证"

5. 保存 访问密钥（客户端ID、客户端密钥和基本），这些信息将用于配置。

配置SDK

使用前面步骤中获得的凭证数据实例化SDK的客户端类

<?php
use Hotmart;

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

API

Hotmart API支持的函数

所有方法都接受端点文档中指定的参数，以及其返回值。

订阅

与订阅相关的操作。

获取订阅

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

查看文档

订阅摘要

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

查看文档

订阅者购买

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

查看文档

取消订阅

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

查看文档

取消订阅列表

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

查看文档

恢复订阅

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

查看文档

恢复订阅列表

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

查看文档

更改订阅收费日

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

查看文档

交易（销售）

与销售相关的操作。

销售历史

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

查看文档

销售摘要

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

查看文档

销售参与者

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

查看文档

销售佣金

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

查看文档

销售价格详情

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

查看文档

销售退款

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

查看文档

会员区

与会员区信息相关的操作。

获取模块

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

查看文档

获取模块页面

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

查看文档

获取用户

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

查看文档

获取用户进度

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

查看文档