APIドキュメント
RateON Exchange API v1
このドキュメントでは、RateONの交換サービスをウォレット、モニタリングプラットフォーム、アプリケーション、またはパートナーサービスに統合する方法を説明します。APIを使用して、交換方向の取得、金額の計算、注文の作成、ステータスの追跡ができます。
https://rateon.io/api/userapi/v1/{method}
交換方向
注文作成
ステータス追跡
Endpoint形式
https://rateon.io/api/userapi/v1/{method}
Content type
リクエスト本文のパラメータには application/x-www-form-urlencoded の使用を推奨します。
curl -X POST "https://rateon.io/api/userapi/v1/test"
-H "API-LOGIN: YOUR_API_LOGIN"
-H "API-KEY: YOUR_API_KEY"
-H "API-LANG: en_US"
| Header | 必須 | 説明 |
|---|---|---|
API-LOGIN | はい | 統合アカウント用に発行されたAPI loginです。 |
API-KEY | はい | 統合アカウント用に発行された非公開API keyです。 |
API-LANG | いいえ | レスポンス言語を指定します。例：en_US、ru_RU。 |
通貨と方向を読み込む
利用可能な交換ペアを表示するために、get_direction_currencies と get_directions を呼び出します。
方向の詳細を取得する
get_direction を呼び出して、レート、準備金、制限、手数料、必須フィールドを取得します。
金額を計算する
注文作成の直前に get_calc を呼び出し、現在の送金額と受取額を計算します。
注文を作成して追跡する
create_bid を呼び出し、その後 bid_info、get_exchanges、または callbacks を使用してステータスを追跡します。
1. ペア選択を作成する
get_direction_currencies と get_directions を使用して、通貨、ペア、direction_id を取得します。
2. 動的フィールドを表示する
get_direction を使用して、必須の give_fields、get_fields、dir_fields を表示します。
3. 送信前に計算する
注文作成の直前に get_calc を使用して、最新の金額を表示し、金額変更の可能性を検出します。
4. 注文を作成してIDを保存する
create_bid を使用し、返された id、hash、status、および支払いアクション情報を保存します。
5. ステータスを追跡する
push通知には callback_url を使用し、その後 bid_info または get_exchanges でステータスを確認します。
6. API actionsに従う
返された api_actions がAPI操作を明示的に許可している場合のみ、pay_bid と cancel_bid を呼び出します。
| メソッド | 目的 | 主な用途 |
|---|---|---|
test | APIアクセスを確認します。 | credentials と IP allowlist を確認するために最初に使用します。 |
get_direction_currencies | 交換に利用可能な通貨を返します。 | 通貨セレクターの作成。 |
get_directions | 利用可能な交換方向を返します。 | ペアリストを作成し、direction_id を取得します。 |
get_direction | 方向に関する詳細情報を返します。 | レート、制限、準備金、必須フィールドを表示します。 |
get_calc | 交換金額を計算します。 | 注文作成前に現在の金額を表示します。 |
create_bid | 交換注文を作成します。 | 最終的な交換リクエストを送信します。 |
bid_info | APIで作成された1件の注文の支払い情報とステータスを返します。 | id または hash で確認します。 |
get_exchanges | 現在のAPI keyで作成された注文を返します。 | 注文履歴の表示またはステータス同期。 |
pay_bid | 許可されている場合、注文を支払い済みにします。 | api_actions.pay = api の場合のみ使用します。 |
cancel_bid | 許可されている場合、注文をキャンセルします。 | api_actions.cancel = api の場合のみ使用します。 |
リクエストパラメータ
必須パラメータはありません。
任意パラメータ
currency_id_give、currency_id_get。
レスポンス
送金側と受取側で利用可能な通貨を返します。このメソッドは通貨セレクターの作成に使用します。
任意パラメータ
currency_id_give、currency_id_get。
レスポンス
各方向には direction_id、送金/受取通貨ID、通貨名、ロゴが含まれます。
必須パラメータ
direction_id — 交換方向のID。
レスポンスフィールド
reserve、course_give、course_get、min_give、max_give、min_get、max_get、give_fields、get_fields、dir_fields などのレスポンスフィールドを使用します。
必須パラメータ
direction_id、calc_amount、calc_action。
calc_action の値
1 送金額、2 受取額、3 手数料込みの送金額、4 手数料込みの受取額。
レスポンスフィールド
sum_give、sum_give_com、sum_get、sum_get_com、com_give、com_get、制限、および changed フラグを使用します。
主なパラメータ
direction_id、calc_amount、calc_action、account1、account2、カスタムフィールド cf1–cf99。
任意パラメータ
api_id、partner_id、callback_url。注文ステータスが変更されたときにRateONからサーバーへ通知を受け取りたい場合は、callback_url を使用します。
レスポンスフィールド
返された id と hash を保存します。status、status_title、金額フィールド、支払い手順、api_actions を使用します。
パラメータ
id または hash を送信します。callback notifications を受け取った後、またはユーザーが注文画面を開いたときに使用します。
任意フィルター
start_time、end_time、ip、id、api_id、status_history、limit、offset。
api_actions.pay
値が api の場合、ウォレットは pay_bid を呼び出せます。支払いリンクまたは支払い手順が返された場合は、ユーザーに表示してください。
api_actions.cancel
値が api の場合、ウォレットは cancel_bid を呼び出せます。それ以外の場合、この注文ではキャンセルが利用できない可能性があります。
api_actions を確認してください。一部のアクションは merchant modules によって自動処理される場合や、特定の注文では利用できない場合があります。Callbacks は、注文が変更された可能性を知らせる server-to-server 通知として使用してください。ウォレットはユーザーインターフェースを更新する前に、必ずAPIで最終状態を確認する必要があります。
Callbacksを有効にする
create_bid を呼び出す際に callback_url を送信します。URLはHTTPSでアクセス可能で、RateONからのPOSTリクエストを受け取れる必要があります。
Callbackデータを受信する
選択された方向と注文フィールドに応じて、callback payload には bid_id、account1、account2、およびカスタム注文フィールド cf1–cf99 が含まれる場合があります。
注文ステータスを確認する
Callbackを受信した後、注文の id または hash を使用して bid_info を呼び出します。複数の注文を同期する必要がある場合は、get_exchanges を使用します。
ウォレット画面を更新する
APIで確認した後にのみ注文画面を更新してください。これにより、callback の遅延、重複、再送による誤ったステータス変更を防げます。
bid_info または get_exchanges で確認する必要があります。| エラー | 考えられる原因 | 推奨される対応 |
|---|---|---|
Api disabled | Credentials が正しくない、またはAPIアクセスが無効です。 | API-LOGIN、API-KEY、APIアクセス、IP allowlist を確認してください。 |
Empty response | 要求されたデータが見つからない、またはパラメータが正しくありません。 | 必須パラメータとIDを確認してください。 |
No bid exists | 要求された注文が存在しません。 | 注文の id または hash を確認してください。 |
Method not supported | 選択されたAPIメソッドがこのAPI keyで有効化されていません。 | 必要なメソッドへのアクセスを申請してください。 |
Direction not found | 要求された交換方向はAPI経由で利用できません。 | 方向の利用可否とAPI権限を確認してください。 |
FAQ
create_bid の直前に get_calc を呼び出すことを推奨します。bid_info、注文履歴には get_exchanges を使用するか、注文作成時に callback_url を送信してください。