Dokümanlar/API ve Webhook'lar/Uyumluluk

Uyumluluk

Aynı eğitim verisi üzerinden iki paralel kapsam görünümü. OWASP görünümü, iş gücünüzü dört OWASP Top 10 ailesine (Web, API, Mobile, Client) karşı puanlar. Düzenleyici görünüm aynı eğitimi, her kontrolü altta yatan CWE'lere eşleyerek harici standartlara (PCI DSS, ISO/IEC 27001, SOC 2) karşı puanlar. Gerekli kapsam: compliance:read.

Uç noktalar

MethodPathKapsamAmaç
GET/api/public/v1/compliance/summarycompliance:readDört framework boyunca OWASP kapsam özeti.
GET/api/public/v1/compliance/frameworks/{'{'}frameworkId{'}'}compliance:readBir OWASP framework'ü için modül başına döküm.
GET/api/public/v1/compliance/regulatory/summarycompliance:readDüzenleyici framework'ler için kapsam özeti.
GET/api/public/v1/compliance/regulatory/{'{'}frameworkId{'}'}compliance:readBir düzenleyici framework için kontrol başına döküm.

Kapsam nasıl hesaplanır

Uygun kullanıcı, rolü org_admin olmayan herhangi bir aktif kurum üyesidir. Bir kullanıcı, son windowDays (365) içinde skoru ≥ passingScore (70) olan en az bir pratik denemesi varsa bir konuda eğitilmiş sayılır. Bir risk öğesi (OWASP modülü veya düzenleyici kontrol), üzerinde eğitilmiş uygun kullanıcı yüzdesi kurumunuzun coverageThresholdPercent değerini geçtiği anda covered durumuna geçer — varsayılan 80, admin arayüzünden 50 ile 100 arasında yapılandırılabilir.

Framework tanımlayıcıları

TürTanımlayıcıBaşlık
OWASPwebOWASP Top 10 (Web)
OWASPapiOWASP API Security Top 10
OWASPmobileOWASP Mobile Top 10
OWASPclientOWASP Client-Side Top 10
Düzenleyicipci-dssPCI DSS v4.0 — Gereksinim 6.2.4
Düzenleyiciiso-27001ISO/IEC 27001:2022 — Annex A güvenli geliştirme
Düzenleyicisoc-2SOC 2 — Trust Services Criteria (TSC 2017)

OWASP özeti

OWASP framework başına bir girdi. Bunu gösterge paneli karoları için kullanın.

GET /api/public/v1/compliance/summary
Authorization: Bearer scs_live_…

Yanıt

{
  "frameworks": [
    {
      "frameworkId": "web",
      "title": "OWASP Top 10 (Web)",
      "totalRiskItems": 10,
      "coveredRiskItems": 7,
      "partialRiskItems": 2,
      "noActivityRiskItems": 1,
      "noContentRiskItems": 0,
      "eligibleUsers": 142,
      "trainedUsers": 118,
      "coveragePercent": 83.1,
      "avgScore": 86.4
    },
    {
      "frameworkId": "api",
      "title": "OWASP API Security Top 10",
      "totalRiskItems": 10,
      "coveredRiskItems": 5,
      "partialRiskItems": 3,
      "noActivityRiskItems": 2,
      "noContentRiskItems": 0,
      "eligibleUsers": 142,
      "trainedUsers": 91,
      "coveragePercent": 64.1,
      "avgScore": 79.2
    }
  ],
  "passingScore": 70,
  "coverageThresholdPercent": 80,
  "windowDays": 365,
  "generatedAt": "2026-05-29T13:42:11.318Z"
}
  • covered + partial + noActivity + noContent = totalRiskItems.
  • noContent, o risk öğesi için henüz eğitim göndermediğimiz anlamına gelir — bir iş gücü başarısızlığı değil, bilinen bir boşluk olarak değerlendirin.
  • avgScore, pencere içindeki geçen denemelerin ortalamasıdır; 0-100 ölçeğinde ifade edilir.

Örnek

curl -sS \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/compliance/summary

OWASP framework detayı

Tek bir framework'e iner — modül başına risk öğelerini, her birinin bileşen konuları ve CWE'leri ile birlikte döner. web | api | mobile | client dışındaki herhangi bir tanımlayıcı için 404 framework_not_found döner.

GET /api/public/v1/compliance/frameworks/web
Authorization: Bearer scs_live_…

Yanıt

{
  "frameworkId": "web",
  "title": "OWASP Top 10 (Web)",
  "summary": {
    "frameworkId": "web",
    "title": "OWASP Top 10 (Web)",
    "totalRiskItems": 10,
    "coveredRiskItems": 7,
    "partialRiskItems": 2,
    "noActivityRiskItems": 1,
    "noContentRiskItems": 0,
    "eligibleUsers": 142,
    "trainedUsers": 118,
    "coveragePercent": 83.1,
    "avgScore": 86.4
  },
  "riskItems": [
    {
      "moduleId": "a01-broken-access-control",
      "title": "A01: Broken Access Control",
      "status": "covered",
      "topicsCount": 4,
      "eligibleUsers": 142,
      "trainedUsers": 124,
      "coveragePercent": 87.3,
      "avgScore": 88.1,
      "topics": [
        {
          "topicId": "idor",
          "title": "Insecure Direct Object References",
          "trainedUsers": 121,
          "totalAttempts": 318,
          "avgScore": 87.6,
          "cwes": ["CWE-639", "CWE-285"]
        }
      ]
    }
  ],
  "passingScore": 70,
  "coverageThresholdPercent": 80,
  "windowDays": 365,
  "generatedAt": "2026-05-29T13:42:11.318Z"
}
  • status şunlardan biridir: covered, partial, no-activity, no-content.
  • totalAttempts pencere içindeki başarısız denemeleri de içerir; trainedUsers yalnızca en az bir başarılı denemesi olan kullanıcıları sayar.

Örnek

curl -sS \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/compliance/frameworks/api

Düzenleyici özeti

Düzenleyici framework'ler için OWASP özetiyle aynı yapı. Her girdi version ve subtitle taşır; böylece standardın tanımlayıcı maddesini doğrudan render edebilirsiniz.

GET /api/public/v1/compliance/regulatory/summary
Authorization: Bearer scs_live_…

Yanıt

{
  "frameworks": [
    {
      "frameworkId": "pci-dss",
      "title": "PCI DSS",
      "version": "v4.0",
      "subtitle": "Payment Card Industry Data Security Standard — Requirement 6 (Secure Systems and Software)",
      "totalControls": 6,
      "coveredControls": 4,
      "partialControls": 1,
      "noActivityControls": 1,
      "noContentControls": 0,
      "eligibleUsers": 142,
      "trainedUsers": 105,
      "coveragePercent": 73.9,
      "avgScore": 84.7
    },
    {
      "frameworkId": "iso-27001",
      "title": "ISO/IEC 27001",
      "version": "2022",
      "subtitle": "Annex A controls — secure development and application security",
      "totalControls": 6,
      "coveredControls": 5,
      "partialControls": 1,
      "noActivityControls": 0,
      "noContentControls": 0,
      "eligibleUsers": 142,
      "trainedUsers": 117,
      "coveragePercent": 82.4,
      "avgScore": 86.0
    }
  ],
  "passingScore": 70,
  "coverageThresholdPercent": 80,
  "windowDays": 365,
  "generatedAt": "2026-05-29T13:42:11.318Z"
}

Örnek

curl -sS \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/compliance/regulatory/summary

Düzenleyici framework detayı

Kontrol başına döküm. Her kontrol, standardın yayımladığı haliyle üst akış açıklamasını ve eğitimi kontrole eşlemek için kullandığımız CWE setini içerir. Bilinmeyen tanımlayıcılar için 404 regulatory_framework_not_found döner.

GET /api/public/v1/compliance/regulatory/pci-dss
Authorization: Bearer scs_live_…

Yanıt

{
  "frameworkId": "pci-dss",
  "title": "PCI DSS",
  "version": "v4.0",
  "subtitle": "Payment Card Industry Data Security Standard — Requirement 6 (Secure Systems and Software)",
  "summary": {
    "frameworkId": "pci-dss",
    "title": "PCI DSS",
    "version": "v4.0",
    "subtitle": "Payment Card Industry Data Security Standard — Requirement 6 (Secure Systems and Software)",
    "totalControls": 6,
    "coveredControls": 4,
    "partialControls": 1,
    "noActivityControls": 1,
    "noContentControls": 0,
    "eligibleUsers": 142,
    "trainedUsers": 105,
    "coveragePercent": 73.9,
    "avgScore": 84.7
  },
  "controls": [
    {
      "controlId": "6.2.4.a",
      "title": "Injection Attacks",
      "description": "Address attacks that inject untrusted data into commands or queries (Req 6.2.4.a).",
      "cwes": ["CWE-89", "CWE-78", "CWE-79", "CWE-94", "CWE-611", "CWE-917", "CWE-918"],
      "status": "covered",
      "topicsCount": 7,
      "eligibleUsers": 142,
      "trainedUsers": 128,
      "coveragePercent": 90.1,
      "avgScore": 88.6,
      "topics": [
        {
          "topicId": "sql-injection",
          "title": "SQL Injection",
          "trainedUsers": 131,
          "totalAttempts": 402,
          "avgScore": 89.4,
          "cwes": ["CWE-89"]
        }
      ]
    }
  ],
  "passingScore": 70,
  "coverageThresholdPercent": 80,
  "windowDays": 365,
  "generatedAt": "2026-05-29T13:42:11.318Z"
}

Örnek

curl -sS \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/compliance/regulatory/iso-27001