ビットコイン取引所「Zaif」のアカウント情報を利用して、他のサービスからAPIを実行できるようになりました。
これまでは取引APIを実行する際に有効期限のないAPI Keyを発行・使用する必要がありました。そのため、もしAPI Keyが外部に漏れた場合、半永久的にAPIが利用されたり、本人以外がユーザに紐づく取引情報を取得する際にはAPI Keyを共有したりする必要がありました。今回、OAuth認証機能を実装したことにより、API Keyを発行せずに取引APIを実行することが可能になり、より安全にZaifのサービスを利用することが可能になりました。
OAuth認証機能を利用するには
Zaifのアカウント情報を利用したサービス(以下クライアントサービス)を展開する業者(以下クライアント)がOAuth認証機能を利用できるようにするための手順を記述します。
1.サービス基本情報を登録します
Zaifにログインし、『アカウント』→『連携アプリケーション基本設定』から「連携アプリケーションの情報を新しく作成する」ボタンを押下し、サービスの詳細な情報を設定してください。| none |
|---|
| none |
2.Zaifアカウント認可画面へのリダイレクトを行えるようにします
クライアントサービスのログイン画面等に、Zaifアカウント認可画面(https://zaif.jp/oauth)へ必要なパラメータを追加してリダイレクトを行えるようにしてください。| none |
|---|
| none |
| none |
|---|
| none |
リダイレクトに成功すると、下記のような認証画面が表示されます。
3.リダイレクトされた情報を解析します
サービス利用ユーザ(以下ユーザ)が認証に成功すると、指定したリダイレクトURLにリクエストが発行されるので、パラメータを解析し、認可処理を行ってください。
| none |
|---|
| none |
4.tokenをリクエストします
前述のcodeパラメータを使って、tokenが取得できるWeb APIを実行し、tokenを取得します。なお、戻り値はJSONになります。エンドポイント:https://oauth.zaif.jp/v1/token
メソッド:POST
| none |
|---|
| none |
| none |
|---|
| none |
5.APIを実行します
今までHTTPヘッダにkey、signパラメータを付与して実行していた取引APIですが、取得したtokenを利用すればそれらは必要なくなります。発行されたaccess tokenをtokenパラメータとしてリクエスト発行時にHTTPヘッダに付与し、APIを実行して下さい。
6.access tokenの期限が切れた場合
期限が切れたaccess tokenは利用できなくなります。下記tokenの再発行Web APIを利用して、token を再発行して下さい。エンドポイント:https://oauth.zaif.jp/v1/refresh_token
メソッド:POST
| none |
|---|
| none |
| none |
|---|
| none |