API Genel Bakışı

SecureCodingHub public REST API'si; admin arayüzünü kazımadan kendi sistemlerinizden kullanıcı sağlamanıza, atama oluşturmanıza, tarayıcı bulgularını içeri almanıza ve olaylara abone olmanıza imkan verir.

API'yi ne zaman kullanmalısınız

Public API'yi, SecureCodingHub'ın ayrı bir gösterge paneli yerine altyapınızın bir parçası gibi davranmasını istediğinizde kullanın. Tipik entegrasyonlar:

CI/CD pipeline'ları — CodeQL, Snyk, Semgrep veya herhangi bir SAST aracından gelen SARIF çıktısını besleyerek commit yazarına hedeflenmiş eğitim atamalarını otomatik oluşturun.
İK / IdP senkronizasyonu — işe alımda kullanıcı sağlayın, ayrılışta deaktive edin; SCIM'in yanında çalışır.
Ticketing ve SOAR — bir geliştirici zorunlu bir atamada başarısız olduğunda Jira ticket'ı açın veya bir sertifika süresi dolduğunda PagerDuty olayı tetikleyin.
Özel raporlama — ilerleme ve denetim verilerini kendi BI aracınıza (Looker, Metabase, Tableau) çekin.
Beyaz etiketli gösterge panelleri — tamamlanma istatistiklerini kendi iç portalınıza gömün.

Base URL ve sürümleme

Her public uç noktaya sürümü yola sabitlenmiş tek bir base URL üzerinden ulaşılır:

https://api.limeplate.com/api/public/v1

v1 sözleşmesi kararlıdır. Geriye dönük uyumsuz değişiklikler yeni bir yolda v2 olarak yayınlanacaktır; yeni bir ana sürüm genel kullanıma sunulduktan sonra v1 en az 12 ay daha kullanılabilir kalır.

İki yüzey, tek platform

app.securecodinghub.com altındaki admin web uygulaması ve api.limeplate.com/api/public/v1 altındaki public API kasıtlı olarak ayrıdır. Farklı kimlik doğrulama şemaları, farklı hız limiti politikaları ve farklı tanımlayıcı kuralları kullanırlar. Dahili uç noktalar (/api/sch/...) önceden haber verilmeksizin değişebilir; yalnızca bu bölümde belgelenen uç noktalar garantilidir.

30 saniyelik tur

Yeni bir entegrasyon için akış neredeyse her zaman şöyle olur:

Admin konsolunda Organization → API Keys altında bir API anahtarı oluşturun. Yalnızca ihtiyacınız olan kapsamları verin (users:read, assignments:write, vb.).

scs_live_… token'ı kopyalayın. Token oluşturulduğunda yalnızca bir kez gösterilir — hemen secrets manager'ınıza kaydedin.

Herhangi bir uç noktaya Authorization: Bearer scs_live_… göndererek ilk çağrınızı yapın.

SecureCodingHub içinden kaynaklanan olaylar için (bir atama tamamlandı, bir SARIF çalıştırması içeri alındı) bir webhook uç noktasına abone olun ve her teslimattaki HMAC imzasını doğrulayın.

İlk isteğiniz

Bu çağrı, API anahtarına sahip kurumun meta verilerini döner. Yeni bir token oluşturduktan sonra önerilen sağlık kontrolüdür:

curl https://api.limeplate.com/api/public/v1/org \
  -H "Authorization: Bearer scs_live_yourkeyhere"

Başarılı bir yanıt şöyle görünür:

{
  "id": "e188fc87-1334-48bd-84d7-5e3e64cecb52",
  "name": "Acme Corp",
  "slug": "acme",
  "domain": "acme.com",
  "plan": "growth",
  "maxSeats": 500,
  "trialExpiresAt": null,
  "isActive": true,
  "createdAt": "2026-01-12T08:42:11Z"
}

Kurallar

Konu	Kural
İletim	Yalnızca HTTPS. Düz HTTP istekleri kenarda reddedilir.
Kodlama	JSON istek ve yanıt gövdeleri. Her POST ve PATCH'te `Content-Type: application/json`.
Büyük-küçük harf	Tüm alan adları hem istek hem yanıtlarda (ve webhook payload'larında) `camelCase` kullanır.
Zaman damgaları	ISO 8601 UTC dizgileri (`2026-05-29T13:45:12Z`).
Tanımlayıcılar	Tüm kaynak ID'leri RFC 4122 v4 UUID'leridir.
Boş gövdeler	Yalnızca bir işlemi onaylayan uç noktalar `{ "message": "..." }` ile `200 OK` döner.
Idempotency	Önemli olduğu yerlerde (örn. SARIF içeri alımı), idempotency ayrı bir header yerine istekteki doğal tanımlayıcılarla anahtarlanır.

OpenAPI spesifikasyonu

Her public uç noktayı tanımlayan bir OpenAPI 3.0 belgesi aynı host'tan sunulur:

https://api.limeplate.com/openapi/v1.json

Bu URL'yi doğrudan Postman, Insomnia, Stoplight veya herhangi bir kod üretim aracına (openapi-generator, @hey-api/openapi-ts, NSwag) yapıştırarak tipli bir client iskeletini oluşturabilirsiniz.

Destek ve durum

Operasyonel sorunlar, geriye dönük uyumsuz değişiklikler ve kullanımdan kaldırma bildirimleri kurumunuza kayıtlı e-posta adresine gönderilir. Entegrasyon soruları ve hata raporları için, başarısız bir çağrıdan yakalayabilirseniz X-Request-Id request header'ı ile birlikte support@securecodinghub.com adresine yazın — sorun çözüm sürecini ciddi şekilde hızlandırır.