API referansı
Geçerli Tungsto API ile kimlik doğrulayın
Hesap, faturalandırma ve sunucu uç noktalarıyla entegrasyondan önce desteklenen oturum çerezi ve CSRF sözleşmesini anlayın.
Bu sayfada
Başlamadan önce
- Mevcut bir hesap ve çalışan hesap hizmetine HTTPS üzerinden erişim.
- İstekler arasında oturum çerezlerini koruyan bir istemci.
- Değişiklikler için, aynı etkin oturumla ilişkili CSRF belirteci.
Desteklenen kimlik doğrulama yöntemini kullanın
Korumalı API yolları, oturum açmayla kurulan hesap oturumunu kullanır. Oturum çerezi __Host-tungsto-session olarak adlandırılır ve Secure ile HttpOnly olarak işaretlenir. İkinci bir çerez olan __Host-tungsto-csrf, istek doğrulamayı destekler. Hesap değişiklikleri, oturum çerezine ek olarak bu oturumla eşleşen bir x-csrf-token başlığı gerektirir.
SSH ve API anahtarları ekranı, kapsamlı anahtarlar oluşturur, listeler ve iptal eder. Authorization: Bearer ve ardından tek kullanımlık anahtarı gönderin. Okuma kapsamı GET /api/v1/servers, sunucu ayrıntısı ve /api/v1/orders erişimi sağlar. Sunucular kapsamı sunucular, sunucu ayrıntısı ve /api/v1/network erişimi sağlar. Faturalandırma kapsamı GET /api/v1/ledger. erişimi sağlar. Tarayıcı oturumu mevcut olsa bile tüm API anahtar değişiklikleri reddedilir. Parola değişikliği veya hesap kurtarma mevcut anahtarları iptal eder. Bu yerel önizleme üzerinde gözetimsiz üretim donanımı veya ödeme otomasyonu kurmayın.
Bir oturum oluşturun ve doğrulayın
Yukarıdaki istek yalnızca alan adlarını gösterir. Kimlik bilgilerini kendi istemcinizde güvenli şekilde sağlayın; paylaşılan örneklerde veya tanılama çıktısında gerçek parola saklamayın. Tarayıcıdan gelen istekler aynı sitede kalmalıdır. Başka bir kaynağı belirten Origin başlığı reddedilir.
- Kullanıcı adı ve parola içeren bir JSON POST isteğini /api/v1/auth/login adresine gönderin. Başarılı yanıtın döndürdüğü Set-Cookie değerlerini istemcinin korumalı çerez deposunda saklayın.
- JSON yanıtında dönen csrfToken'ı o oturumla birlikte saklayın. Bir oturum açmadan gelen belirteci başka bir oturumun çerezleriyle karıştırmayın.
- Hesabı doğrulamak için çerezlerle GET /api/v1/me çağırın. Yanıtı username, balanceUsd ve csrfToken içerir.
- Korumalı bir değişiklik için oturum çerezlerini, Content-Type: application/json ve x-csrf-token'ı gönderin. Uç nokta gerektirdiğinde bir Idempotency-Key ekleyin.
- İstemci işini bitirdiğinde POST /api/v1/auth/logout kullanarak oturumu sonlandırın.
POST /api/v1/auth/login HTTP/1.1
Content-Type: application/json
{"username":"your-username","password":"your-password"}Oturum süresi ve doğrulama hatalarını ele alın
Başarılı bir hesap kurtarma, parolayı değiştirir, mevcut oturumları iptal eder ve yeni bir kurtarma kodu verir. Önceki çerezleri kullanan istemciler yeniden kimlik doğrulaması yapmalıdır. Hizmet ayrıca oturumları sona erdirir, bu nedenle önceden başarılı bir bağlantı sınırsız bir kimlik bilgisi değildir.
| Yanıt | Anlam | Sonraki eylem |
|---|---|---|
| 401 authentication_required | Geçerli bir hesap oturumu bulunamadı. | Tekrar oturum açın ve yeni çerezleri saklayın. |
| 401 session_invalid | Oturum ve CSRF çerezi birlikte doğrulanmaz. | Karışık çerezleri yeniden kullanmak yerine yeni bir oturum açma başlatın. |
| 403 csrf_failed | Değişiklik talebinde eşleşen doğrulama belirteci eksik. | Oturum bilgilerini yeniden yükleyin ve geçerli belirtecini kullanın. |
| 403 origin_rejected | Sağlanan Origin, isteğin kaynağından farklı. | Talebi desteklenen aynı site bağlamından çalıştırın. |
| 429 rate_limited | Çok fazla kimlik doğrulama denemesi yapıldı. | Tekrar denemeden önce bekleyin; sürekli yeniden denemeyin. |
Entegrasyonu mevcut sözleşme içinde tutun
Güvenlik ekranı GET /api/v1/sessions üzerinden etkin oturumları listeler ve DELETE /api/v1/sessions/:id. üzerinden sahip olunan bir oturumu iptal eder. Anahtarlar ekranı API anahtarlarını listeler ve iptal eder. OAuth akışı yoktur. Kayıt ve kurtarma, hizmet hesabı mekanizmasının yerine geçmeyen etkileşimli hesap erişim işlemleridir. Bir kişinin oturum çerezlerini birden çok araç veya kullanıcı arasında dağıtmaktan kaçının.
Kimlik doğrulama başarısı almak hesap erişimini onaylar, her harici işlemin kullanılabilir olduğunu değil. Kripto ödemesi bağlı bir sağlayıcı gerektirir; fiziksel sunucu eylemleri operatörün kuyruklu istekleri yürütmesini gerektirir. Başarılı bir yanıtı tamamlanmış gerçek dünya eylemi olarak yorumlamadan önce uç noktaya özgü sonuçlar ve yeniden deneme davranışı için işlemler kılavuzunu okuyun.