API başvurusu
Temel adres: https://api.rempar.org/v1. Her yerde JSON. Başarılı yanıtlar {"data": ...} içine, hatalar {"error": {"code": "...", "message": "..."}} içine sarılır. Kimlik doğrulama, her cihaza özgü bir Bearer belirteciyle yapılır.
API sıfır bilgi esaslıdır: hiçbir zaman parola veya açık metin içerik almaz. v1 protokolüne uydukları sürece üçüncü taraf istemcilere kapımız açıktır.
Sağlık
GET /v1/health
→ { "data": { "status": "ok", "release": "1.1.0" } }
Kimlik doğrulama
| Yöntem | Rota | Gövde | Yanıt |
|---|---|---|---|
| POST | /auth/prelogin |
{email} |
{kdf, kdf_salt}. E-posta bilinmiyorsa deterministik sahte bir tuz. |
| POST | /auth/register |
{email, auth_key, kdf, kdf_salt, device} |
201 {status: "verification_sent"}. E-postayla altı haneli bir kod gönderilir. |
| POST | /auth/verify-email |
{email, code} |
{} |
| POST | /auth/login |
{email, auth_key, device, totp?, code?} |
{tokens, device_id, vault_key_sealed?}. 2FA etkinse ve kod yoksa totp_required (403) hatası. Ardından email_code_required (403): e-postayla altı haneli bir kod gönderilir, belirteçleri almak için bu kod code içinde geri gönderilir (10 dk, 5 deneme). |
| POST | /auth/refresh |
{refresh_token} |
{access_token, refresh_token, ...}. Döndürme; yeniden oynatma cihazı iptal eder. |
| POST | /auth/logout |
Geçerli cihazı iptal eder. | |
| POST | /auth/recover |
{email, recovery_auth, totp?} |
Kurtarma kiti kanıtı: {vault_key_recovery, recovery_token} döndürür (15 dk). 2FA etkinse totp_required. |
| POST | /auth/recover/complete |
{email, recovery_token, auth_key, kdf, kdf_salt, vault_key_sealed, device} |
Yeni ana parola: kimlik doğrulama anahtarını ve yeniden mühürlenen kasa anahtarını değiştirir, diğer tüm cihazları iptal eder, bu cihazı bağlar ({tokens, device_id, vault_key_sealed}). |
device: {name, platform, client_id}; burada client_id, istemcinin seçtiği ve bu cihaz için sabit kalan bir UUID'dir.
kdf: {"algo": "argon2id", "m": 65536, "t": 3, "p": 4}. İstemciler m=19456, t=2, p=1 değerlerinden zayıf parametreleri reddeder.
Hesap
| Yöntem | Rota | Açıklama |
|---|---|---|
| GET | /account |
E-posta, 2FA durumu, kasa revizyonu, abonelik {plan, active, until}. |
| GET | /account/subscription |
Yalnızca abonelik. |
| POST | /account/password |
Ana parola değişikliğinden sonra auth_key değerini değiştirir. İstemci önce yeniden mühürlenen kasa anahtarını yayımlar. |
| GET | /account/devices |
Etkin cihazlar. |
| DELETE | /account/devices/{id} |
Bir cihazı iptal eder. |
| POST | /account/totp/setup |
Bir gizli anahtar üretir ve {secret, otpauth_url} döndürür. |
| POST | /account/totp/enable |
{code}: 2FA'yı etkinleştirir. |
| POST | /account/totp/disable |
{code}: 2FA'yı devre dışı bırakır. |
Kasa
| Yöntem | Rota | Açıklama |
|---|---|---|
| PUT | /vault/key |
{vault_key_sealed, vault_key_recovery?}: yalnızca mühürlü bloblar, atomik olarak değiştirilir. Her zaman izinlidir (geri yükleme). |
| GET | /vault/items?since=<revision>&limit=500 |
{items: [{id, revision, deleted, blob, updated_at}], revision}. Etkin bir abonelik gerektirir. |
| POST | /vault/items |
{base_revision, items: [{id, blob|null}]} → {revision, conflicts: []}. blob: null siler (mezar taşı). base_revision eskiyse sunucu yazmak yerine newer_items döndürür. Gönderim başına en fazla 500 öğe. Etkin bir abonelik gerektirir. |
Abonelik
Cloud aboneliği, Stripe, App Store veya Google Play üzerinden başlatılan 7 günlük ücretsiz denemeyle (trial) başlar (bkz. GET /v1/account/subscription). Etkin bir abonelik yoksa eşitleme rotaları 402 subscription_required yanıtını verir; geri yüklemeye izin vermek için mühürlü kasa anahtarı okunabilir kalır. İstemci “Bekliyor” gösterir ve yerel olarak çalışmaya devam eder.
Hata kodları
| Kod | HTTP | Anlamı |
|---|---|---|
invalid_credentials |
401 | E-posta, anahtar veya kod yanlış. |
unauthenticated |
401 | Belirteç yok, süresi dolmuş veya cihaz iptal edilmiş. |
email_unverified |
403 | E-posta kodu girilmemiş. |
totp_required |
403 | totp sağlayın. |
subscription_required |
402 | Cloud aboneliğinin süresi dolmuş. |
email_taken |
409 | Bu e-postayla doğrulanmış bir hesap zaten var. |
stale_revision |
409 | Önce döndürülen newer_items öğelerini çekin. |
token_reused |
401 | Yeniden oynatma algılandı, cihaz iptal edildi. |
Hız sınırları
Ön giriş 30/dk, kayıt ve doğrulama 10/dk, giriş 15/dk, yenileme 30/dk, kimliği doğrulanmış rotalar cihaz başına 240/dk.
Örnek
curl -s https://api.rempar.org/v1/auth/prelogin \
-H 'Content-Type: application/json' \
-d '{"email":"vous@example.org"}'
Sorunuzun yanıtını burada bulamadınız mı? support@rempar.org