README

安装

CueCloud PHP API 客户端可以通过 Composer 安装。按照这些步骤安装，您应该不会遇到任何问题。

Composer

您需要为您的项目创建一个 composer 文件，您可以自己编辑它或运行 composer 后回答它提出的问题来生成。

composer init

您需要将 CueCloud PHP API 客户端设置为您项目的一个必需包，使用包标识符（cuecloud/cuecloud-php）。

您的 composer.json 应该看起来像这样

结果应该像这样（请注意 require 项）

{
    "name": "test/my-test",
    "description": "This is a test",
    "license": "MIT License",
    "authors": [
        {
            "name": "John Doe",
            "email": "john@doe.com"
        }
    ],
    "require": {
        "cuecloud/cuecloud-php": "dev-master"
    }
}

配置

配置是通过 CueCloud\API\Client 的构造函数完成的。这是强制性的，如果不传递，则 API 的任何方法都不会工作。

use CueCloud\API\Client as CueCloudAPI;

$apiKey = 'your_API_key';
$apiPass = 'your_secret_password';

$client = new CueCloud($apiKey, $apiPass);

还可以传递其他参数：API 的版本和基本 URL（尽管此参数仅对 CueCloud 开发者有用）。

用法

一旦您在 composer 中添加了库作为需求，并在实例化 CueCloud 客户端时设置了您的 API 密钥和密码，您就可以调用提供的任何方法。

validateUser()

测试方法，以确保用户具有有效的 API 凭证。

getKeywords()

请求 Cues 的常用关键词，这些关键词在列表中返回。

getBalance()

请求用户的当前余额，以美元计。

makeDeposit($amountUSD, $ccLastFour)

如果应用中有一个有效的信用卡，这将向用户的余额中存入指定金额。

withdrawFunds($amountUSD)

给定一个 PayPal 电子邮件地址，这将立即将资金存入该用户的 PayPal 账户。

grantBonus($cueCompletionId, $amount, $reason, $noteToSelf)

这将授予完成了特定 Cue 的用户的奖金。

getPayments($paymentType, $paymentId, $noteToSelf, $page)

获取支付列表，并提供一些筛选选项。如果没有提供筛选，将返回所有支付。

approveCueCompletion($cueCompletionId)

批准用户已提交的 CueCompletion。

拒绝用户已提交的 CueCompletion。

cancelCue($cueId)

取消用户已发布的 Cue，并退款其余额。

createCue($title, $amount, $numOpportunities, $description, $isAnonymous, $pushNotificationOnCueCompletion, $disallowAnonymous, $iFrameUrl, $urlNotificationOnCueCompletion, $emailNotificationOnCueCompletion, $lifetimeInMinutes, $timeLimitToCompleteCueInMinutes, $autoApproveCueCompletionInMinute, $noteToSelf, $keywords)

创建一个新的 Cue。唯一的必需参数是标题、金额和机会数量（默认为 1）。可以指定一个 iframe URL，以便用户在给定的 URL（通常是您的网站）上填写自定义表单。

getCues($cueId, $groupId, $noteToSelf, $hasPendingCueCompletions, $status, $page)

获取用户创建的所有 Cue 的列表。一些筛选选项作为参数可用。

assignCue($cueId)

尝试根据该用户是否已检出该 Cue 来检查或退订 Cue。

getCueCompletion($cueId, $cueCompletionId, $status, $page)

获取特定 Cue 的 CueCompletions，或通过 CueCompletion 或状态筛选。

submitCueCompletion($assignmentId, $answerText, $videoUrl, $videoThumbnail, $imageUrl, $isAnonymous)

提交CueCompletion数据，虽然在生产环境中，该方法会阻塞所有没有HTTP_REFERER的请求。

运行测试

包括一系列集成测试。要执行它们，请使用已通过composer安装的phpunit（因为它是CueCloud PHP API客户端的开发依赖项）

phpunit ./tests/

这将使用phpunit.xml中包含的设置。

或者（仅对CueCloud开发者有用）可以使用phpunit.local.xml中的设置在本地开发服务器上运行集成测试，执行

phpunit -c phpunit.local.xml ./tests/

cuecloud / cuecloud-php

维护者

详细信息