PHP SDK

GitHubからダウンロードしてください。使用例も含まれています。

CrowdHandler PHP SDK

CrowdHandlerのパブリックAPIおよびプライベートAPIと連携するためのPHP SDK。ユーザーの確認やキューへの登録を行うための豊富な機能を備えています。

パブリックAPIクライアントのインスタンスを作成する

$api = new CrowdHandler\PublicClient($yourPublicKey);

新しい GateKeeper オブジェクトをインスタンス化する

リクエストの詳細(暗黙的、従来のPHP)

$gatekeeper = new CrowdHandler\GateKeeper($api);

GateKeeper クラスは、ユーザーのリクエストや CrowdHandler API とやり取りを行い、適切な処理を実行するためのコントローラーです。

PSR7リクエストの使用

$request = new \Psr\Http\Message\ServerRequestInterface;
$gatekeeper = new CrowdHandler\GateKeeper($api, request);

GateKeeperは、デフォルトではsuperglobals内のurl、ip、agentなどを検査します。ただし、ご希望の場合や、お使いのフレームワークで指定されている場合は、PSRリクエストを渡すこともできます。

オプション

デバッグモード

$gatekeeper->setDebug(true);

一部の処理をPHPのエラーログに記録し、リダイレクトもスキップします。これにより、頻繁にリダイレクトされることなく、何が起きているかを確認できます。確認してください $gatekeeper->getRedirectUrl() どこにリダイレクトされるかを確認するには。

URLを無視する

$gatekeeper->setIgnoreUrls($regexp);

デフォルトでは、一般的なアセット(png、jpgなど)はAPIチェックの対象外となり、自動的に上位に表示されます。必要に応じて、独自の正規表現を指定することも可能です。この場合、既存の正規表現が上書きされるため、必要に応じてアセットを含めるように設定する必要があります。

フェイルオーバー待機室

$gatekeeper->setSafetyNetSlug('yourslug');

デフォルトでは、API呼び出しが失敗した場合、または形式不備のレスポンスを受信した場合、APIから詳細な情報が返されるまで、CrowdHandlerの最終的なキャッチオール待機ページにリダイレクトされます。このような状況において、独自の既知のキャッチオール待機ページへリダイレクトしたい場合(推奨)、ここでスラッグを設定することができます。

自分の道を歩む

$gatekeeper->setToken($_SESSION['token']);

デフォルトでは、GateKeeperは、サイト上のCrowdHandlerとのユーザーのセッションを維持するために、Cookieを検査・設定します。別の方法でセッションを管理したい場合は、トークンを自分で設定することができます。

IP検出が正しく機能していない? 自分で設定してみましょう

$gatekeeper->setIP($_SERVER['X-MY-WEIRD-LOADBALANCER-FORWARDS-THE-REAL-IP-LIKE-THIS']);

ユーザーのIPアドレスを追跡するのは簡単なことのように思えますが、ロードバランシングやクラウドホスティング環境では、ユーザーのIPアドレスではなくロードバランサーのIPアドレスが取得されてしまうことがあります。GateKeeperは、一般的なロードバランサーのパターンを含め、IPアドレスを検出するための一般的なパターンを試しますが、設定が特殊な場合は、明示的に設定することで検出結果を上書きすることができます。 IPアドレスを正確に追跡することは重要です。同じユーザーが2つのIPアドレスを通じて追跡されると、そのユーザーが待機中か取引中かによって、誤ってブロックされたり、ブロックされた状態とブロックされていない状態が同時に発生したりする可能性があります。

現在のリクエストを確認する

$gatekeeper->checkRequest();

これがこのクラスの核心部分です。ユーザーのリクエストを受け取り、APIに問い合わせを行い、ユーザーにアクセス権を付与すべきか、それとも待機室に送るべきかを示す結果を取得します。

クッキーを設定する

自動

$gatekeeper->setCookie();

ここで、ユーザーがリクエストのたびにトークンを保持できるようにクッキーを設定します。これは重要な点です。トークンの確認ができない場合、新しいトークンが発行され、その結果、昇格したユーザーが待機室に送られてしまう可能性があります。

自分の道を歩む

$_SESSION['ch-id'] = $gatekeeper->result->token;

標準のクッキーを使用したくない場合は、独自の方法を採用することも可能です。なお、トークンの保存にPHPのセッションを使用することは、通常20分でタイムアウトしてしまうため、あまりお勧めしません。 ユーザーが何時間も待機室に留まり、その後新しいタブでサイトのURLにアクセスしようとすると、キューの最後尾に新しい位置が割り当てられてしまう可能性があります。このため、通常はセッションまたは永続的なクッキーの使用が推奨されます。

ユーザーに待機が必要な場合は、別のページへリダイレクトする

自動

$gatekeeper->redirectIfNotPromoted()

このユーザーが待機する必要がある場合は、適切な待機室に案内されます。条件分岐によるチェックを行う必要はありません。

自分でやってみよう

if (!$gatekeeper->result->promoted) {
    header('location: '.$gatekeeper->getRedirectUrl(), 302);
    exit;
}

条件分岐によるチェックを行いたい場合は、このチェックを行う必要があります。また、リダイレクト先のURLの探し方についても説明します。

プライベートAPIクライアントのインスタンスを作成する

$api = new CrowdHandler\PrivateClient($yourPrivateKey);

オブジェクトの配列を取得する

すべて

$rs = $api->rooms->get();

パラメータ付き

$rs = $api->rooms->get(['domainID'=>'dom_y0urk3y']);

反復処理

foreach($rs as $room) print $room;

物を取ってくる

$room = $api->rooms->get('room_your1d');

オブジェクトを更新する

$api->domains->put('dom_y0ur1d', ['rate'=>50, 'autotune'=>true]);

オブジェクトを投稿する

$api->templates->post(['name'=>'My Template', 'url'=>'https://mysite.com/wait.html']);

オブジェクトを削除する

$api->groups->delete('grp_y0ur1d')