Ninow API

クライアントキー更新API

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

Ninow

概要

エンドポイント

POST /issue/ckey

リクエストパラメータ

No パラメータ名 項目名 任意/必須 設定値(例) 形式 説明
1 client_key クライアントキー 必須 abcdefghij0123456789 英数字 認証に使用する既存の有効なAPIキー。
このキーに紐づく契約企業・利用者に対して新しいAPIキーを発行します。

レスポンスパラメータ(正常)

No パラメータ名 項目名 設定値 / 形式 説明
1 status 成否 "OK" 正常時は "OK" を返します。
2 body.result 成否 true
3 body.key 発行APIキー 16桁の英数字 新しく発行されたAPIキー(client_key)。
4 body.expire_date 有効期限 Y-m-d 発行したキーの有効期限。

レスポンスパラメータ(エラー) ※HTTPステータスコードが400・401等の場合

No パラメータ名 項目名 設定値 / 形式 説明
1 status 成否 "NG" エラー時は "NG" を返します。
2 body.result 成否 false
3 body.error エラーメッセージ 文字列 認証エラー等の内容(例: Authentication Failed.)。

リクエスト例(テスト環境)

POST https://demo02.exchanger.ninow.jp/issue/ckey Content-Type: application/x-www-form-urlencoded client_key=(既存の有効なAPIキー)

レスポンス例

✅ 成功時 { "status": "OK", "body": { "result": true, "key": "Ab12Cd34Ef56Gh78", "expire_date": "2026-12-01" } } ❌ 失敗時 { "status": "NG", "body": { "result": false, "error": "Authentication Failed." } }

サンプルコード(cURL)

curl -X POST https://demo02.exchanger.ninow.jp/issue/ckey \ --data-urlencode "client_key=YOUR_CLIENT_KEY"

注意事項