Prokerala Astrology PHP SDK
prokerala/astrology-sdk は、Prokerala Astrology API v2 の公式 PHP クライアントです。エンドポイントごとに型付きサービス クラス、PSR-18/17 HTTP 抽象化、オプションの PSR-16 トークン キャッシング、およびゲッター付きの型付き結果オブジェクトを提供します。
ソース リポジトリ: https://github.com/prokerala/astrology-sdk
このスキルの使用方法
- SDK の利用(インストール、ブートストラップ、最初の呼び出し):
references/getting-started.mdをお読みください。 - エンドポイントに適したサービス クラスの検索:
references/services.mdをお読みください(すべての 99 サービスが API パスにマッピングされています)。 - SDK の変更または拡張(新しいエンドポイント、結果クラス、テスト):
references/maintainer-guide.mdをお読みください。 - エンドポイント パラメータ、列挙型、およびレスポンス スキーマは、コンパニオン API スキル
prokerala-astrology-apiに記載されています。SDK スキルではこれらを重複して記載しません。
要件
- PHP >= 8.0
- Composer パッケージ:
prokerala/astrology-sdkに加え、PSR-17/PSR-18 実装(例:nyholm/psr7+guzzlehttp/guzzle)、およびオプションでトークン キャッシング用の PSR-16 キャッシュ(例:symfony/cache)。
クイック リファレンス
use GuzzleHttp\Client as HttpClient;
use Nyholm\Psr7\Factory\Psr17Factory;
use Prokerala\Common\Api\Authentication\Oauth2;
use Prokerala\Common\Api\Client;
use Prokerala\Api\Astrology\Location;
use Prokerala\Api\Astrology\Service\Kundli;
$psr17Factory = new Psr17Factory();
$httpClient = new HttpClient();
// オプションの第 6 引数: 任意の PSR-16 キャッシュ。OAuth トークンを有効期限までキャッシュします。
$authClient = new Oauth2($clientId, $clientSecret, $httpClient, $psr17Factory, $psr17Factory, $cache);
$client = new Client($authClient, $httpClient, $psr17Factory);
$location = new Location(23.1765, 75.7885, 0, new DateTimeZone('Asia/Kolkata'));
$datetime = new DateTimeImmutable('2022-03-17T10:50:40+05:30');
$result = (new Kundli($client))->process($location, $datetime);
$nakshatra = $result->getNakshatraDetails()->getNakshatra()->getName();
- サービスはコンストラクタで
Clientを受け取り、単一のprocess(...)メソッドを公開します。 - 座標は
Locationで渡します。日時はDateTimeImmutableで渡します(SDK は内部で ISO 8601 形式にフォーマットします)。 $client->getCreditUsed()は、最後の呼び出しで消費された API クレジットを返します(X-Api-Creditsヘッダーから)。
例外
すべて Prokerala\Common\Api\Exception にあり、Client::process() によってスローされます。
| Exception | HTTP ステータス | 意味 |
|---|---|---|
ValidationException | 400 | 無効な入力。完全な errors リストを保持します。 |
AuthenticationException | 401 | 資格情報が無効または期限切れ。 |
QuotaExceededException | 403 | API クレジット不足。 |
RateLimitExceededException | 429 | リクエストが多すぎます。バックオフしてください。 |
ServerException | 500 | サーバー側の障害。 |
Exception | その他 | 基本クラス。キャッチオール。 |
TokenExpiredException は内部で処理されます(クライアントがトークンを更新し、1 回再試行します)。コンシューマ コードでキャッチする必要はありません。