Ninow API

荷主キー更新API

荷主キー(s_key)を更新(再発行)するAPIです。既存の有効なAPIキーで認証し、対象荷主の新しい荷主キーを取得して切り替えます。

Ninow

概要

エンドポイント

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"

注意事項