クイックスタート — 5分で始めるAPI管理
API Pulse Grid プラットフォームへようこそ。このガイドでは、APIゲートウェイの基本設定から最初のAPIの公開までを説明します。
前提条件： APIキーの発行が必要です。管理コンソールからキーを取得してください。
Step 1: SDKのインストール
SHELL
# npmを使用してSDKをインストール
npm install @apipulsegrid/sdk
# または yarn を使用
yarn add @apipulsegrid/sdk
Step 2: 初期設定
JAVASCRIPT
const { APGClient } = require('@apipulsegrid/sdk');
const client = new APGClient({
apiKey: 'YOUR_API_KEY',
region: 'ap-northeast-1', // 東京リージョン
environment: 'production'
});
認証設定
API Pulse Grid は複数の認証方式をサポートしています。セキュリティ要件に合わせてお選びください。
| 認証方式 | 用途 | 推奨環境 |
|---|---|---|
API Key | シンプルな認証。開発・テスト環境に最適 | 開発・テスト |
OAuth 2.0 | ユーザー委任アクセス。B2B・B2C統合に適合 | 本番環境 |
JWT Bearer | ステートレス認証。マイクロサービス間通信に最適 | 本番環境 |
mTLS | 証明書による相互認証。高セキュリティ環境向け | 金融・医療 |
推奨： 本番環境では OAuth 2.0 または mTLS を使用することを強く推奨します。
OAuth 2.0 設定例
JAVASCRIPT
const authConfig = {
type: 'oauth2',
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
scopes: ['gateway:read', 'gateway:write'],
tokenEndpoint: 'https://auth.apipulsegrid.com/token'
};
APIゲートウェイ — エンドポイント一覧
APIゲートウェイの主要エンドポイントです。すべてのリクエストにはBearerトークンが必要です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /v1/gateways | ゲートウェイ一覧の取得 |
POST | /v1/gateways | 新規ゲートウェイの作成 |
GET | /v1/gateways/{id} | 特定のゲートウェイ情報の取得 |
PUT | /v1/gateways/{id} | ゲートウェイ設定の更新 |
DELETE | /v1/gateways/{id} | ゲートウェイの削除 |
GET | /v1/gateways/{id}/routes | ルーティング設定の取得 |
POST | /v1/gateways/{id}/routes | ルートの追加 |
注意： DELETEエンドポイントは取り消しができません。本番環境での操作は十分ご確認ください。
レスポンス例
JSON
{
"id": "gw-abc123",
"name": "production-gateway",
"status": "active",
"region": "ap-northeast-1",
"endpoints": 3,
"requestsPerSecond": 1500,
"createdAt": "2026-01-15T09:00:00Z"
}
トラブルシューティング
よくある問題と解決方法をご確認ください。
401 Unauthorized エラーが返される
APIキーまたはトークンが無効・期限切れの可能性があります。
→ 管理コンソールでキーの有効期限を確認し、必要に応じて再発行してください。
429 Too Many Requests エラーが発生する
レート制限に達しています。現在のプランの上限を超えています。
→ リクエスト頻度を下げるか、上位プランへのアップグレードをご検討ください。
タイムアウトが多発する
バックエンドサービスのレスポンス遅延が原因の可能性があります。
→ 監視ダッシュボードでバックエンドのレスポンスタイムを確認し、タイムアウト設定を調整してください。
解決しない場合は、技術サポートチームにお問い合わせください。
技術サポートに連絡