API 문서

RateON Exchange API v1

이 문서는 RateON 교환 서비스를 지갑, 모니터링 플랫폼, 애플리케이션 또는 파트너 서비스에 통합하는 방법을 설명합니다. API를 사용하면 교환 방향을 가져오고, 금액을 계산하고, 주문을 생성하며, 상태를 추적할 수 있습니다.

API 액세스 요청 메서드 보기

Base URL

/api/userapi/v1/

https://rateon.io/api/userapi/v1/{method}

요청 / 응답

POST → JSON

모든 파라미터는 요청 본문으로 전송됩니다. 응답은 JSON 형식으로 반환됩니다.

빠른 시작

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`.

보안: API key는 반드시 서버 측에만 보관하세요. 브라우저 JavaScript, 공개 모바일 앱 코드 또는 클라이언트 측 애플리케이션에 노출하지 마세요.

권장 통합 흐름

통화 및 방향 불러오기

사용 가능한 교환 페어를 표시하려면 get_direction_currencies 및 get_directions를 호출하세요.

1

방향 상세 정보 가져오기

get_direction를 호출하여 환율, 준비금, 한도, 수수료 및 필수 필드를 가져오세요.

2

금액 계산하기

주문 생성 직전에 get_calc를 호출하여 현재 송금 금액과 수령 금액을 계산하세요.

3

주문 생성 및 추적

create_bid를 호출한 다음 bid_info, get_exchanges 또는 callbacks를 사용하여 상태를 추적하세요.

4

지갑 통합 체크리스트

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 및 결제 action 데이터를 저장하세요.

5. 상태 추적

push 알림에는 callback_url을 사용하고, 이후 bid_info 또는 get_exchanges로 상태를 검증하세요.

6. API actions 준수

반환된 api_actions가 API action을 명시적으로 허용하는 경우에만 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로 생성된 단일 주문의 결제 정보와 상태를 반환합니다.	`id` 또는 `hash`로 확인합니다.
`get_exchanges`	현재 API key로 생성된 주문을 반환합니다.	주문 내역 표시 또는 상태 동기화.
`pay_bid`	허용된 경우 주문을 결제 완료로 표시합니다.	`api_actions.pay = api`인 경우에만 사용하세요.
`cancel_bid`	허용된 경우 주문을 취소합니다.	`api_actions.cancel = api`인 경우에만 사용하세요.

메서드 레퍼런스

POST testAPI credentials와 접근 권한이 정상적으로 작동하는지 확인합니다. ⌄

요청 파라미터

필수 파라미터는 없습니다.

POST get_direction_currencies교환에 사용할 수 있는 통화를 반환합니다. ⌄

선택 파라미터

currency_id_give, currency_id_get.

응답

보내는 쪽과 받는 쪽에서 사용할 수 있는 통화를 반환합니다. 이 메서드는 통화 선택기를 구성하는 데 사용하세요.

POST get_directionsAPI를 통해 사용 가능한 교환 방향을 반환합니다. ⌄

선택 파라미터

currency_id_give, currency_id_get.

응답

각 방향에는 direction_id, 보내는/받는 통화 ID, 통화 이름 및 로고가 포함됩니다.

POST get_direction선택한 교환 방향에 대한 전체 정보를 반환합니다. ⌄

필수 파라미터

direction_id — 교환 방향 ID.

응답 필드

reserve, course_give, course_get, min_give, max_give, min_get, max_get, give_fields, get_fields, dir_fields 등의 응답 필드를 사용하세요.

POST get_calc선택한 방향의 교환 금액을 계산합니다. ⌄

필수 파라미터

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 플래그를 사용하세요.

POST create_bid새 교환 주문을 생성합니다. ⌄

주요 파라미터

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를 사용하세요.

POST bid_infoAPI로 생성된 단일 주문의 결제 정보와 상태를 반환합니다. ⌄

파라미터

id 또는 hash를 전송하세요. callback notifications 이후 또는 사용자가 주문 화면을 열 때 이 메서드를 사용하세요.

POST get_exchanges현재 API key로 생성된 주문을 반환합니다. ⌄

선택 필터

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에서 자동으로 처리되거나 특정 주문에서 사용할 수 없을 수 있습니다.

주문 상태

new새 주문

coldnew검증 대기 중

payed사용자가 주문을 결제 완료로 표시함

realpay결제 수신됨

verify검토 중

success주문 완료

cancel주문 취소됨

error주문 오류

partpay부분 결제

payouterror지급 오류

mercherrorMerchant module 오류

delete주문 삭제됨

Callback 알림

Callbacks는 주문이 변경되었을 수 있음을 알리는 server-to-server 알림으로 사용해야 합니다. 지갑은 사용자 인터페이스를 업데이트하기 전에 항상 API를 통해 최종 상태를 검증해야 합니다.

Callbacks 활성화

create_bid 호출 시 callback_url을 전달하세요. URL은 HTTPS로 접근 가능해야 하며 RateON의 POST 요청을 받을 수 있어야 합니다.

1

Callback 데이터 수신

선택한 방향 및 주문 필드에 따라 callback payload에는 bid_id, account1, account2 및 사용자 지정 주문 필드 cf1–cf99가 포함될 수 있습니다.

2

주문 상태 검증

Callback을 받은 후 주문 id 또는 hash를 사용하여 bid_info를 호출하세요. 여러 주문을 동기화해야 하는 경우 get_exchanges를 사용하세요.

3

지갑 화면 업데이트

API 검증 후에만 주문 화면을 업데이트하세요. 이렇게 하면 callback 지연, 중복 또는 재시도로 인한 잘못된 상태 변경을 방지할 수 있습니다.

4

중요: callbacks를 유일한 진실의 출처가 아니라 알림으로 취급하세요. 현재 주문 상태는 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

API credentials는 어떻게 받을 수 있나요?

RateON 지원팀에 연락하여 회사명, 사용 사례, 필요한 API 메서드 및 서버 IP 주소를 제공하세요. Credentials는 승인 후 발급됩니다.

API 접근을 IP로 제한할 수 있나요?

예. 보안을 위해 API 접근은 승인된 서버 IP 주소로만 제한할 수 있습니다.

주문 생성 전에 get_calc를 호출해야 하나요?

예. 최신 교환 금액을 계산하기 위해 create_bid 직전에 get_calc를 호출하는 것을 권장합니다.

주문 상태는 어떻게 추적하나요?

단일 주문에는 bid_info, 주문 내역에는 get_exchanges를 사용하거나 주문 생성 시 callback_url을 전달하세요.

통합을 시작할 준비가 되셨나요?

사용 사례, 필요한 API 메서드 및 서버 IP 주소를 보내주세요. Credentials를 준비하고 첫 테스트 요청을 도와드리겠습니다.

지원팀에 문의