tapfiliate/sdk-php

tapfiliate.com 客户端

0.1.0 2022-12-14 11:38 UTC

This package is not auto-updated.

Last update: 2024-09-19 19:27:32 UTC


README

Tapfiliate API 的 PHP 包装器

安装

安装 https://getcomposer.org.cn/ 并运行以下命令

php composer.phar require tapfiliate/sdk-php

PHP SDK 配置

要使用 SDK,您需要

  • 配置 ApiClient
  • 配置执行操作的处理器

如何配置 ApiClient?

您只需要填写所需的参数

$logger = new NullLogger();
$helper = new ModelFiller();
$api = new ApiClient($logger, '<Your API key>');

如何获取 API 密钥?

  • 前往 Tapfiliate 平台。
  • 登录您的发布者账户。
  • 点击您的账户图片。
  • 然后选择 配置文件 > API 密钥
  • 并复制 API 密钥 文本字段中的值

如何获取 Tapfiliate 主机?

默认情况下,它设置为: https://api.tapfiliate.com
但您可以通过向 ApiClient 构造函数添加自己的数据来修改主机

如何配置处理器?

ClicksHandler 配置示例

$clickHandler = new ClicksHandler($api, $helper);

点击创建示例

$clicks = new Click();
// You can set specific data to Click model (e.g referral code)
$clicks->setReferralCode('<referral code>');
$clickHandler->createClick($clicks);

执行 createClick 操作后,它将返回一个填充了 API 响应的 Clicks 对象。
响应示例

object(Tapfiliate\Models\Click) {
    ["id":"Tapfiliate\Models\Click":private]=> string(36) "<click id>"
    ["referralCode":"Tapfiliate\Models\Click":private]=> string(6) "<referral code>"
    ["sourceId":"Tapfiliate\Models\Click":private]=> NULL
    ["referrer":"Tapfiliate\Models\Click":private]=> NULL
    ["landingPage":"Tapfiliate\Models\Click":private]=> NULL
    ["userAgent":"Tapfiliate\Models\Click":private]=> NULL
    ["ip":"Tapfiliate\Models\Click":private]=> NULL
    ["metaData":"Tapfiliate\Models\Click":private]=> array(0) {
    }
}

如果出现问题,ClicksHandler 将抛出异常。