SDKを統合
curlまたはBrunoでの検証が成功したら、SDKに移行してください。API Clientの認証情報はバックエンドに保持し、検証済みの認証・デバイス照会フローを再利用します。
利用可能なSDK
SDKは現在、WLTE OpenAPI SDKリポジトリでソースコードとして配布されています。
| 言語 | ディレクトリ |
|---|---|
| TypeScript | sdk/typescript |
| Python | sdk/python |
| Go | sdk/go |
bash
git clone https://github.com/svnwi/wlte-openapi-sdk.git現在の対応範囲には、認証、デバイス照会、デバイスタイプ定義、リレー制御、RS485、デバイス設定、コマンド結果の照会が含まれます。
TypeScript
bash
cd wlte-openapi-sdk/sdk/typescript
cp .env.example .env
npm install
npm run example:list-devices
npm run example:list-profilesPython
bash
cd wlte-openapi-sdk
cp sdk/python/.env.example sdk/python/.env
python3 sdk/python/examples/list_devices.py
python3 sdk/python/examples/list_profiles.pyGo
bash
cd wlte-openapi-sdk/sdk/go
cp .env.example .env
go run ./examples/list_devices
go run ./examples/list_profiles本番投入前のチェックリスト
clientIdとclientSecretはサーバー側のシークレットストレージから読み込んでください。- アクセストークンは
expiresInの少し手前までキャッシュしてください。 - HTTPステータスとレスポンスの
codeを処理し、messageで分岐しないでください。 Retry-Afterを尊重し、上限のあるリトライを使用してください。- 認証情報やトークンをログに残さずに、トラブルシューティング用に
requestIdを記録してください。 - ベースラインの同期にはREST、継続的なイベントが必要な場合はWebSocketを使ってください。