API Referansı

Atlas REST API’si JSON döner, kimlik doğrulama için Bearer belirteci kullanır ve sürümü yol üzerinde taşır.

Temel adres https://api.atlas.example/v1

Kimlik doğrulama

Her istek bir Authorization başlığı taşımalıdır. Anahtarınızı çalışma alanı ayarlarından üretebilirsiniz.

curl https://api.atlas.example/v1/users \
  -H "Authorization: Bearer atl_live_••••••••"

Hız sınırı

Anahtar başına dakikada 600 istek. Sınırı aşan istekler 429 döner; Retry-After başlığındaki saniye kadar bekleyin.

Kullanıcılar

Çalışma alanındaki kullanıcıları listeleyin, oluşturun ve güncelleyin.

GET /v1/users

Kullanıcıları listele

Çalışma alanındaki kullanıcıları sayfalı olarak döner. Sonuçlar oluşturulma tarihine göre yeniden eskiye sıralanır.

Parametreler

Ad	Tip	Zorunlu	Açıklama
limit	integer	Hayır	Sayfa başına kayıt sayısı. 1–100 arası, varsayılan 25.
cursor	string	Hayır	Bir önceki yanıtın `next_cursor` değeri. Sonraki sayfayı getirir.
role	string	Hayır	Role göre süz: `owner`, `admin` veya `member`.

Örnek istek

curl https://api.atlas.example/v1/users?limit=2 \
  -H "Authorization: Bearer atl_live_••••••••"

Örnek yanıt

{
  "object": "list",
  "data": [
    {
      "id": "usr_9Fq2xK",
      "email": "[email protected]",
      "name": "Elif Demir",
      "role": "admin",
      "created_at": "2026-05-14T08:21:00Z"
    },
    {
      "id": "usr_3Bn7pL",
      "email": "[email protected]",
      "name": "Deniz Aksoy",
      "role": "member",
      "created_at": "2026-05-02T11:40:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "usr_3Bn7pL"
}

POST /v1/users

Kullanıcı oluştur

Çalışma alanına yeni bir kullanıcı ekler ve adrese davet e-postası gönderir. Aynı e-posta zaten kayıtlıysa 409 döner.

Parametreler

Ad	Tip	Zorunlu	Açıklama
email	string	Evet	Davet edilecek e-posta adresi.
name	string	Hayır	Görünen ad. Boş bırakılırsa e-postanın yerel kısmı kullanılır.
role	string	Hayır	`admin` veya `member`. Varsayılan `member`.

Örnek istek

curl -X POST https://api.atlas.example/v1/users \
  -H "Authorization: Bearer atl_live_••••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "name": "Yeni Kullanıcı",
    "role": "member"
  }'

Örnek yanıt

{
  "id": "usr_1Kd8mQ",
  "email": "[email protected]",
  "name": "Yeni Kullanıcı",
  "role": "member",
  "status": "invited",
  "created_at": "2026-08-09T10:02:00Z"
}

PATCH /v1/users/{id}

Kullanıcıyı güncelle

Yalnızca gönderdiğiniz alanlar değişir. Çalışma alanının tek sahibinin rolü düşürülemez.

Parametreler

Ad	Tip	Zorunlu	Açıklama
id	string	Evet	Kullanıcı kimliği. Yol parametresidir.
name	string	Hayır	Yeni görünen ad.
role	string	Hayır	`owner`, `admin` veya `member`.

Örnek istek

curl -X PATCH https://api.atlas.example/v1/users/usr_1Kd8mQ \
  -H "Authorization: Bearer atl_live_••••••••" \
  -H "Content-Type: application/json" \
  -d '{ "role": "admin" }'

Örnek yanıt

{
  "id": "usr_1Kd8mQ",
  "email": "[email protected]",
  "name": "Yeni Kullanıcı",
  "role": "admin",
  "status": "active",
  "updated_at": "2026-08-09T10:14:00Z"
}

DELETE /v1/users/{id}

Kullanıcıyı çıkar

Kullanıcıyı çalışma alanından çıkarır. Ürettiği içerik silinmez, sahipliği çalışma alanına devredilir.

Parametreler

Ad	Tip	Zorunlu	Açıklama
id	string	Evet	Kullanıcı kimliği. Yol parametresidir.

Örnek istek

curl -X DELETE https://api.atlas.example/v1/users/usr_1Kd8mQ \
  -H "Authorization: Bearer atl_live_••••••••"

Örnek yanıt

{
  "id": "usr_1Kd8mQ",
  "object": "user",
  "deleted": true
}

Oturum

Belirteç üretme, yenileme ve sonlandırma işlemleri.

POST /v1/auth/token

Belirteç al

İstemci kimliği ve gizli anahtarla kısa ömürlü bir erişim belirteci üretir. Belirteç 1 saat geçerlidir.

Parametreler

Ad	Tip	Zorunlu	Açıklama
client_id	string	Evet	Uygulama ayarlarındaki istemci kimliği.
client_secret	string	Evet	Yalnızca sunucu tarafında saklanmalıdır.
scope	string	Hayır	Boşlukla ayrılmış izin listesi. Örn. `users:read users:write`.

Örnek istek

curl -X POST https://api.atlas.example/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "cli_7Hs2",
    "client_secret": "••••••••",
    "scope": "users:read"
  }'

Örnek yanıt

{
  "access_token": "atl_live_••••••••",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "users:read"
}

POST /v1/auth/refresh

Belirteci yenile

Süresi dolmak üzere olan belirteci yeniler. Eski belirteç yenileme anında geçersizleşir.

Parametreler

Ad	Tip	Zorunlu	Açıklama
refresh_token	string	Evet	İlk belirteçle birlikte dönen yenileme anahtarı.

Örnek istek

curl -X POST https://api.atlas.example/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{ "refresh_token": "rft_••••••••" }'

Örnek yanıt

{
  "access_token": "atl_live_••••••••",
  "token_type": "Bearer",
  "expires_in": 3600
}

DELETE /v1/auth/session

Oturumu sonlandır

Geçerli belirteci hemen geçersiz kılar. Yanıt gövdesi boştur (204).

Örnek istek

curl -X DELETE https://api.atlas.example/v1/auth/session \
  -H "Authorization: Bearer atl_live_••••••••"

Örnek yanıt

HTTP/1.1 204 No Content

Webhooklar

Olay aboneliklerini yönetin ve teslim denemelerini görün.

POST /v1/webhooks

Webhook kaydet

Seçtiğiniz olaylar gerçekleştiğinde adresinize POST isteği gönderilir. Her istek X-Atlas-Signature başlığıyla imzalanır.

Parametreler

Ad	Tip	Zorunlu	Açıklama
url	string	Evet	HTTPS uç noktası. 5 saniye içinde 2xx dönmelidir.
events	array	Evet	Abone olunacak olaylar. Örn. `["user.created"]`.
description	string	Hayır	Panelde görünecek kısa açıklama.

Örnek istek

curl -X POST https://api.atlas.example/v1/webhooks \
  -H "Authorization: Bearer atl_live_••••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://ornek.com/atlas/olaylar",
    "events": ["user.created", "user.deleted"]
  }'

Örnek yanıt

{
  "id": "whk_5Rt9",
  "url": "https://ornek.com/atlas/olaylar",
  "events": ["user.created", "user.deleted"],
  "secret": "whsec_••••••••",
  "status": "active"
}

GET /v1/webhooks

Webhookları listele

Kayıtlı tüm abonelikleri ve son teslim durumlarını döner.

Parametreler

Ad	Tip	Zorunlu	Açıklama
status	string	Hayır	`active` veya `disabled` olarak süzer.

Örnek istek

curl https://api.atlas.example/v1/webhooks \
  -H "Authorization: Bearer atl_live_••••••••"

Örnek yanıt

{
  "object": "list",
  "data": [
    {
      "id": "whk_5Rt9",
      "url": "https://ornek.com/atlas/olaylar",
      "events": ["user.created", "user.deleted"],
      "status": "active",
      "last_delivery": {
        "code": 200,
        "at": "2026-08-09T09:58:12Z"
      }
    }
  ],
  "has_more": false
}