API Referansı

Kimlik Doğrulama

FloopFloop API'sine kimlik doğrulamak için API anahtarları nasıl oluşturulur ve kullanılır.

Son güncelleme:

API Anahtarı Kimlik Doğrulaması

Tüm API istekleri, Bearer token şemasını kullanarak Authorization başlığına API anahtarınızı içermelidir:

Authorization: Bearer flp_your_api_key_here

API Anahtarı Oluşturma

API anahtarlarını oluşturmak ve yönetmek için FloopFloop panonuzdakiAccount → API Keys bölümüne gidin.

  • Her hesapta en fazla 5 aktif API anahtarı olabilir
  • Anahtarlar yalnızca oluşturulma anında gösterilir — güvenli bir yerde saklayın
  • Anahtarlar panodan her zaman iptal edilebilir
  • Tüm anahtarlar flp_ önekiyle başlar

Anahtar Güvenliği

  • API anahtarlarınızı asla paylaşmayın veya sürüm kontrolüne eklemeyin
  • Anahtarları uygulamalarınızda saklamak için ortam değişkenlerini kullanın
  • Anahtarları düzenli olarak yenileyin ve kullanılmayan anahtarları iptal edin
  • Her anahtarın kendi hız sınırı havuzu vardır

Hız Sınırları

API uç noktaları, API anahtarı başına aşağıdaki hız sınırlarına sahiptir:

OperationLimitWindow
Okuma işlemleri (GET)120 requests1 minute
Yazma işlemleri (POST/PATCH/DELETE)30 requests1 minute
Deploy/Rollback5 requests1 hour
Proje oluşturma/Klonlama10 requests1 hour

Hız sınırı bilgileri yanıt başlıklarına dahildir:X-RateLimit-Remaining ve X-RateLimit-Reset.

Kimlik Doğrulamasını Doğrulama

GET /api/v1/user/me

API anahtarınızın geçerli olduğunu doğrulamak için bu uç noktayı kullanın. Kimliği doğrulanmış kullanıcının profilini döndürür ve her resmi SDK ile CLI'deki floop whoamikomutu tarafından kullanılan standart “kimlik doğrulamayı test et” çağrısıdır.

curl https://floopfloop.com/api/v1/user/me \
  -H "Authorization: Bearer flp_your_api_key_here"

Yanıt (200):

{
  "data": {
    "id": "user_abc123",
    "email": "you@example.com",
    "name": "Your Name",
    "role": "user",
    "source": "api_key"
  }
}
  • role — Normal hesaplar için "user", platform çalışanları için "admin".
  • source — İsteğin nasıl doğrulandığı. Programatik kimlik bilgileri için "api_key", cihaz yetkili CLI akışı için "cli_token".

Burada 401 UNAUTHORIZED hatası, anahtarın eksik, iptal edilmiş veya hatalı biçimlendirilmiş olduğu anlamına gelir. 403 FORBIDDENhatası ise hesabın var olduğu ancak API erişimini kısıtlayan Business planına sahip olmadığı anlamına gelir (API Genel Bakış'taki Gereksinimlerbölümüne bakın).

Programatik API Anahtarı Yönetimi

Çoğu kullanıcı anahtarlarını panodan oluşturur, ancak aynı işlevler düzenleme senaryoları için API üzerinden de kullanılabilir — bir CI işinden anahtar döndürme, kullanımı denetlemek için anahtarları listeleme veya UI'a girmeden sızdırılmış bir anahtarı iptal etme gibi durumlarda. Bu, CLI'deki floop keys list/create/remove komutlarının yaptığını yansıtır.

API Anahtarlarını Listele

GET /api/v1/api-keys

Hesaptaki her aktif (iptal edilmemiş) anahtar için meta veri döndürür. Düz metin anahtar materyali hiçbir zaman döndürülmez — yalnızca keyPrefix (anahtarın ilk 8 hex karakteri, flp_ önekiyle).

{
  "data": {
    "keys": [
      {
        "id": "key_abc",
        "name": "ci-deploy",
        "keyPrefix": "flp_a1b2c3d4",
        "scopes": null,
        "lastUsedAt": "2026-04-24T18:30:00Z",
        "createdAt": "2026-04-01T12:00:00Z"
      }
    ]
  }
}

API Anahtarı Oluştur

POST /api/v1/api-keys
{
  "name": "ci-deploy"    // required, 1-100 chars
}

Yanıt (201):

{
  "data": {
    "id": "key_xyz",
    "rawKey": "flp_a1b2c3d4…full-40-hex…",
    "keyPrefix": "flp_a1b2c3d4"
  }
}

rawKey yalnızca bir kez gösterilir— sonraki okumalar yalnızca keyPrefix'i döndürür. Hemen saklayın. Her hesap en fazla 5 aktif anahtar ile sınırlıdır; bu limite ulaşırsanız istek 409 LIMIT_EXCEEDEDdöndürür — önce kullanılmayan bir anahtarı iptal edin.

Anahtar oluşturmak için Business planı gereklidir. Business planı olmayan bir hesaptan yapılan istek, “Creating API keys requires the Business plan” mesajıyla 403 FORBIDDEN döndürür. Platform yöneticileri bu kısıtlamayı aşabilir.

API Anahtarını İptal Et

DELETE /api/v1/api-keys/{keyId}

Anahtarın id'sini (ör. key_xyz) yol parametresi olarak geçin. Anahtar hemen geçersiz kılınır — halihazırda bir worker üzerinde olan istekler tamamlanabilir, ancak yeni istekler kimlik doğrulaması yapamaz.

Yanıt (200):

{ "data": { "success": true } }
  • Kendi kendini iptal etme engellenmiştir. İsteği yapan anahtarla DELETE çağrısı yapmak 400 VALIDATION_ERRORdöndürür — bu, CLI'nin çağrı sırasında kendini kesmesini önler. Farklı bir anahtar kullanın veya panodan iptal edin.
  • Bilinmeyen veya zaten iptal edilmiş anahtarlar404 NOT_FOUND döndürür.

Resmi SDK'lar apiKeys.remove()yardımcılarında bir id veya anahtar adını kabul eder, adı istemci tarafında bir liste çağrısıyla id'ye çözer. API'nin kendisi yalnızca id'yi kabul eder.

İptal edilen bir anahtar geri yüklenemez; yerine yeni bir tane oluşturun. İptal işlemi Account → API Keys bölümünde gösterilen denetim günlüğüne kaydedilir.