Prokerala 占星 PHP SDK
prokerala/astrology-sdk 是適用於 Prokerala 占星 API v2 的官方 PHP 客戶端。它為每個端點提供型別化的服務類別、PSR-18/17 HTTP 抽象層、可選的 PSR-16 令牌快取,以及具有 getter 方法的型別化結果物件。
原始碼倉庫: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() 擲出:
| 例外狀況 | HTTP 狀態碼 | 說明 |
|---|---|---|
ValidationException | 400 | 輸入無效;包含完整的 errors 列表 |
AuthenticationException | 401 | 憑證錯誤或已過期 |
QuotaExceededException | 403 | API 配額已用盡 |
RateLimitExceededException | 429 | 請求過多;請暫緩 |
ServerException | 500 | 伺服器端錯誤 |
Exception | 其他 | 基底類別;捕捉所有例外 |
TokenExpiredException 在內部處理(客戶端會重新整理令牌並重試一次);消費者程式碼無需捕捉。