APIドキュメント
Mercozy APIを統合して商品、注文、在庫などを管理する方法を学びましょう。
はじめに
1
APIキーを取得
管理者としてログインし、 設定 > インテグレーション > APIキー に移動して新しいキーを生成します。管理者のみ権限があります。
2
リクエストに含める
すべてのAPIリクエストに X-API-Key ヘッダーを追加してください。
3
リクエストの送信を開始
任意のHTTPクライアントを使用してMercozy APIエンドポイントと通信できます。
認証
すべてのAPIリクエストには、X-API-Keyヘッダーで送信される有効なAPIキーが必要です。
bash
curl https://api.mercozy.com/api/v1/external/products \
-H "X-API-Key: mk_live_your_key_here"APIキーはテナントに紐付いています。秘密に保ち、クライアント側のコードに公開しないでください。
ベースURL
https://api.mercozy.com/api/v1/externalレート制限
APIレート制限はサブスクリプションプランによって異なります。
| プラン | レート制限 | APIアクセス |
|---|---|---|
| Free / Standard | APIアクセスなし | No |
| Pro | 300 リクエスト/分 | Yes |
| Business | 1,000 リクエスト/分 | Yes |
レスポンス形式
すべてのレスポンスはJSON形式で返されます。
成功レスポンス
json
{
"data": [
{
"id": "prod_abc123",
"name": "Premium Widget",
"price": 2999,
"currency": "USD"
}
],
"meta": {
"total": 42,
"page": 1,
"limit": 20
}
}エラーレスポンス
json
{
"statusCode": 401,
"message": "Invalid API key",
"error": "Unauthorized"
}エラーコード
| コード | ステータス | 説明 |
|---|---|---|
VALIDATION_ERROR | 400 | 無効なリクエストパラメータ |
UNAUTHORIZED | 401 | 無効または欠落しているAPIキー |
FORBIDDEN | 403 | 権限不足 |
NOT_FOUND | 404 | リソースが見つかりません |
CONFLICT | 409 | リソースが既に存在するか競合しています |
RATE_LIMITED | 429 | リクエストが多すぎます |
INTERNAL_ERROR | 500 | 内部サーバーエラー |