概要
- 本APIは、荷主キー(s_key)を更新(再発行)するためのものです。有効期限が近づいた荷主キーの更新にご利用ください。
- 初回のキー発行は運営会社が行います(キー発行手順を参照)。本APIは、通知済みの既存の有効な荷主キーを使って自身でキーを更新する仕組みです。
- 認証には既存の有効なAPIキー(client_key)を使用し、更新対象の荷主は既存の有効な荷主キー(s_key)で特定します。
- 更新すると新しいキーが1本発行(追加)されます。既存キーは有効期限まで有効なため、新旧キーを併用しながら無停止で切り替えできます。
- 発行キーは16桁の英数字(大文字・小文字)、有効期限は発行から90日です。
エンドポイント
POST /issue/skey
リクエストパラメータ
| No | パラメータ名 | 項目名 | 任意/必須 | 設定値(例) | 形式 | 説明 |
|---|---|---|---|---|---|---|
| 1 | client_key | クライアントキー | 必須 | abcdefghij0123456789 | 英数字 | 認証に使用する既存の有効なAPIキー。 |
| 2 | s_key | 荷主キー | 必須 | abcde0123456789 | 英数字 |
更新対象の荷主を特定するための既存の有効な荷主キー。 このキーに紐づく荷主に対して新しい荷主キーを発行します。 |
レスポンスパラメータ(正常)
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "OK" | 正常時は "OK" を返します。 |
| 2 | body.result | 成否 | true | |
| 3 | body.key | 発行荷主キー | 16桁の英数字 | 新しく発行された荷主キー(s_key)。 |
| 4 | body.expire_date | 有効期限 | Y-m-d | 発行したキーの有効期限。 |
レスポンスパラメータ(エラー) ※HTTPステータスコードが400・401等の場合
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "NG" | エラー時は "NG" を返します。 |
| 2 | body.result | 成否 | false | |
| 3 | body.error | エラーメッセージ | 文字列 | 認証エラーや荷主キー無効等の内容(例: 契約企業に再発行を依頼してください)。 |
リクエスト例(テスト環境)
POST https://demo02.exchanger.ninow.jp/issue/skey
Content-Type: application/x-www-form-urlencoded
client_key=(既存の有効なAPIキー)
&s_key=(既存の有効な荷主キー)
レスポンス例
✅ 成功時
{ "status": "OK", "body": { "result": true, "key": "Zz98Yy76Xx54Ww32", "expire_date": "2026-12-01" } }
❌ 失敗時(荷主キーが無効)
{ "status": "NG", "body": { "result": false, "error": "契約企業に再発行を依頼してください" } }
サンプルコード(cURL)
curl -X POST https://demo02.exchanger.ninow.jp/issue/skey \
--data-urlencode "client_key=YOUR_CLIENT_KEY" \
--data-urlencode "s_key=YOUR_S_KEY"
注意事項
- ① 本エンドポイントは POST・
application/x-www-form-urlencodedです。 - ② 認証には既存の有効なAPIキー(client_key)が必要です。無効・期限切れの場合は認証エラー(HTTP 401)となります。
- ③ 更新対象の荷主を特定するために既存の有効な荷主キー(s_key)が必要です。無効な場合はエラーとなります(契約企業へ再発行を依頼してください)。
- ④ 更新のたびに新しいキーが発行(追加)されます。既存キーは有効期限まで失効しないため、切替期間中は新旧キーを併用できます(無停止でのキー更新)。
- ⑤ 更新後は、連携先のご担当者様へ新しいキーを安全な方法で通知し、速やかに切り替えてください。