API Dokümantasyonu
RateON Exchange API v1
Bu dokümantasyon, RateON exchange servisinin bir cüzdana, izleme platformuna, uygulamaya veya partner servisine nasıl entegre edileceğini açıklar. API ile exchange yönlerini alabilir, tutarları hesaplayabilir, order oluşturabilir ve status takibi yapabilirsiniz.
https://rateon.io/api/userapi/v1/{method}
Exchange yönleri
Order oluşturma
Status takibi
Endpoint formatı
https://rateon.io/api/userapi/v1/{method}
Content type
Request body parametreleri için application/x-www-form-urlencoded kullanılması önerilir.
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 | Zorunlu | Açıklama |
|---|---|---|
API-LOGIN | Evet | Entegrasyon hesabınız için verilen API login. |
API-KEY | Evet | Entegrasyon hesabınız için verilen özel API key. |
API-LANG | Hayır | Yanıt dilini zorunlu olarak belirler. Örnek değerler: en_US, ru_RU. |
Para birimlerini ve yönleri yükle
Mevcut exchange paritelerini göstermek için get_direction_currencies ve get_directions çağırın.
Yön detaylarını al
Kur, rezerv, limitler, komisyonlar ve zorunlu alanları almak için get_direction çağırın.
Tutarı hesapla
Güncel gönderim/alım tutarlarını hesaplamak için order oluşturmadan hemen önce get_calc çağırın.
Order oluştur ve takip et
create_bid çağırın, ardından status takibi için bid_info, get_exchanges veya callbacks kullanın.
1. Parite seçimini oluştur
Para birimleri, pariteler ve direction_id almak için get_direction_currencies ve get_directions kullanın.
2. Dinamik alanları göster
Zorunlu give_fields, get_fields ve dir_fields alanlarını göstermek için get_direction kullanın.
3. Göndermeden önce hesapla
Güncel tutarı göstermek ve olası değişiklikleri tespit etmek için order oluşturmadan hemen önce get_calc kullanın.
4. Order oluştur ve ID’leri kaydet
create_bid kullanın ve dönen id, hash, status ve payment action verilerini saklayın.
5. Status takip et
Push bildirimleri için callback_url kullanın, ardından status bilgisini bid_info veya get_exchanges ile doğrulayın.
6. API actions kurallarına uy
pay_bid ve cancel_bid metotlarını yalnızca dönen api_actions açıkça API action izni verdiğinde çağırın.
| Metot | Amaç | Tipik kullanım |
|---|---|---|
test | API erişimini kontrol eder. | Credentials ve IP allowlist kontrolü için ilk olarak kullanın. |
get_direction_currencies | Exchange için kullanılabilir para birimlerini döndürür. | Para birimi seçicileri oluşturmak. |
get_directions | Mevcut exchange yönlerini döndürür. | Parite listesini oluşturmak ve direction_id almak. |
get_direction | Bir yön hakkında detaylı bilgi döndürür. | Kur, limitler, rezerv ve zorunlu alanları göstermek. |
get_calc | Exchange tutarını hesaplar. | Order oluşturmadan önce güncel tutarı göstermek. |
create_bid | Exchange order oluşturur. | Final exchange request göndermek. |
bid_info | API ile oluşturulan tek bir order için ödeme bilgisi ve status döndürür. | id veya hash ile kontrol etmek. |
get_exchanges | Mevcut API key ile oluşturulan order listesini döndürür. | Order geçmişini göstermek veya status senkronizasyonu yapmak. |
pay_bid | İzin verildiğinde order’ı ödenmiş olarak işaretler. | Yalnızca api_actions.pay = api olduğunda kullanın. |
cancel_bid | İzin verildiğinde order’ı iptal eder. | Yalnızca api_actions.cancel = api olduğunda kullanın. |
Request parametreleri
Zorunlu parametre yoktur.
Opsiyonel parametreler
currency_id_give, currency_id_get.
Yanıt
Gönderim ve alım tarafı için kullanılabilir para birimlerini döndürür. Bu metodu para birimi seçicileri oluşturmak için kullanın.
Opsiyonel parametreler
currency_id_give, currency_id_get.
Yanıt
Her yön direction_id, gönderim/alım para birimi ID’leri, para birimi adları ve logoları içerir.
Zorunlu parametre
direction_id — exchange yönünün ID’si.
Yanıt alanları
reserve, course_give, course_get, min_give, max_give, min_get, max_get, give_fields, get_fields ve dir_fields gibi yanıt alanlarını kullanın.
Zorunlu parametreler
direction_id, calc_amount, calc_action.
calc_action değerleri
1 gönderim tutarı, 2 alım tutarı, 3 komisyon dahil gönderim tutarı, 4 komisyon dahil alım tutarı.
Yanıt alanları
sum_give, sum_give_com, sum_get, sum_get_com, com_give, com_get, limitler ve changed flag alanını kullanın.
Ana parametreler
direction_id, calc_amount, calc_action, account1, account2, özel alanlar cf1–cf99.
Opsiyonel parametreler
api_id, partner_id, callback_url. RateON’un order status değiştiğinde sunucunuzu bilgilendirmesini istiyorsanız callback_url kullanın.
Yanıt alanları
Dönen id ve hash değerlerini saklayın. status, status_title, tutar alanları, ödeme talimatı ve api_actions alanlarını kullanın.
Parametreler
id veya hash gönderin. Bu metodu callback notifications sonrasında ve kullanıcı order ekranını açtığında kullanın.
Opsiyonel filtreler
start_time, end_time, ip, id, api_id, status_history, limit, offset.
api_actions.pay
Değer api ise cüzdan pay_bid çağırabilir. Bir ödeme linki veya ödeme talimatı dönerse kullanıcıya gösterin.
api_actions.cancel
Değer api ise cüzdan cancel_bid çağırabilir. Aksi durumda bu order için iptal işlemi kullanılamayabilir.
api_actions kontrol edin. Bazı işlemler merchant modules tarafından otomatik işlenebilir veya belirli bir order için kullanılamayabilir.Callbacks, bir order değişmiş olabileceğini bildiren server-to-server notification olarak kullanılmalıdır. Cüzdan, kullanıcı arayüzünü güncellemeden önce final durumu her zaman API üzerinden doğrulamalıdır.
Callbacks’i etkinleştir
create_bid çağırırken callback_url gönderin. URL HTTPS üzerinden erişilebilir olmalı ve RateON’dan gelen POST isteklerini alabilmelidir.
Callback verilerini al
Callback payload, seçilen yöne ve order alanlarına bağlı olarak bid_id, account1, account2 ve özel order alanları cf1–cf99 içerebilir.
Order status doğrula
Callback aldıktan sonra order id veya hash kullanarak bid_info çağırın. Birden fazla order senkronize etmeniz gerekiyorsa get_exchanges kullanın.
Cüzdan arayüzünü güncelle
Order ekranını yalnızca API doğrulamasından sonra güncelleyin. Bu, callback geciktiğinde, tekrarlandığında veya yeniden gönderildiğinde hatalı status değişikliklerini önler.
bid_info veya get_exchanges ile doğrulanmalıdır.| Hata | Olası neden | Önerilen işlem |
|---|---|---|
Api disabled | Credentials hatalı veya API erişimi kapalı. | API-LOGIN, API-KEY, API erişimi ve IP allowlist ayarlarını kontrol edin. |
Empty response | İstenen veri bulunamadı veya parametreler hatalı. | Zorunlu parametreleri ve ID’leri kontrol edin. |
No bid exists | İstenen order mevcut değil. | Order id veya hash değerini kontrol edin. |
Method not supported | Seçilen API metodu bu API key için etkin değil. | Gerekli metoda erişim talep edin. |
Direction not found | İstenen exchange yönü API üzerinden kullanılamıyor. | Yönün kullanılabilirliğini ve API izinlerini kontrol edin. |
FAQ
create_bid çağırmadan hemen önce get_calc çağırmanızı öneririz.bid_info, order geçmişi için get_exchanges kullanın veya order oluştururken callback_url gönderin.Entegrasyona hazır mısınız?
Kullanım senaryonuzu, gerekli API metotlarını ve sunucu IP adreslerinizi gönderin. Credentials hazırlayalım ve ilk test isteğinde yardımcı olalım.
Destek ile iletişime geç