Teknik Dokümantasyon

API Dokümantasyonu

KolayStartup REST API'si ile platform verilerine programatik erişim sağlayın. Bu sayfa temel kavramları özetler; tam uç nokta referansı için interaktif Swagger arayüzünü kullanın.

Genel Bakış

KolayStartup API'si JSON tabanlı bir REST API'dir. Tüm istekler HTTPS üzerinden yapılır ve yanıtlar UTF-8 kodlamasıyla döner. Public uç noktalar isteğe bağlı bir geliştirici anahtarı (X-Api-Key) kabul ederken, kullanıcıya özel uç noktalar oturum (Bearer JWT) gerektirir.

Temel URL: https://www.kolaystartup.com/api
Public sürüm yolu: /api/public/v1/*
OpenAPI 3 şeması: /api/openapi.json
İnteraktif arayüz: /docs (Swagger UI) ve /api/docs (ReDoc)

Kimlik Doğrulama

İki erişim modeli vardır. Public okuma uç noktaları için geliştirici anahtarınızı X-Api-Key başlığında gönderin. Kullanıcıya özel uç noktalar için oturum açıp Authorization: Bearer <token> başlığını kullanın.

# Public okuma (geliştirici anahtarı opsiyonel)
curl -H "X-Api-Key: $KS_DEV_KEY" \
  https://www.kolaystartup.com/api/public/v1/industries

# Oturumlu istek (Bearer token)
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://www.kolaystartup.com/api/public/v1/me

Not: Geliştirici anahtarınızı asla istemci tarafı koduna gömmeyin. Sunucu tarafı ortam değişkeni olarak saklayın.

İstek ve Yanıt Formatı

İstek gövdeleri application/json olmalıdır. Başarılı yanıtlar 2xx durum kodu ve bir veri zarfı döner. Hatalar yapılandırılmış bir hata nesnesi içerir.

// Başarılı yanıt
{
  "data": { "id": "...", "name": "..." }
}

// Hata yanıtı
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Geçerli bir oturum gerekli"
  }
}

Hızlı Başlangıç (fetch)

const res = await fetch(
  'https://www.kolaystartup.com/api/public/v1/industries',
  { headers: { 'X-Api-Key': process.env.KS_DEV_KEY ?? '' } },
);
const { data } = await res.json();
console.log(data);

Sonraki Adımlar

Tüm uç noktaları, parametreleri ve örnek yanıtları interaktif olarak keşfetmek için Swagger arayüzünü açın. Webhook ve OAuth entegrasyonları için ilgili sayfalara bakın.

İlgili Sayfalar

Yükleniyor…

Genel Bakış

Temel URL: https://www.kolaystartup.com/api

Public sürüm yolu: /api/public/v1/*

OpenAPI 3 şeması: /api/openapi.json

İnteraktif arayüz: /docs (Swagger UI) ve /api/docs (ReDoc)

Kimlik Doğrulama

# Public okuma (geliştirici anahtarı opsiyonel) curl -H "X-Api-Key: $KS_DEV_KEY" \ https://www.kolaystartup.com/api/public/v1/industries # Oturumlu istek (Bearer token) curl -H "Authorization: Bearer $ACCESS_TOKEN" \ https://www.kolaystartup.com/api/public/v1/me

Not: Geliştirici anahtarınızı asla istemci tarafı koduna gömmeyin. Sunucu tarafı ortam değişkeni olarak saklayın.

İstek ve Yanıt Formatı

İstek gövdeleri application/json olmalıdır. Başarılı yanıtlar 2xx durum kodu ve bir veri zarfı döner. Hatalar yapılandırılmış bir hata nesnesi içerir.

// Başarılı yanıt { "data": { "id": "...", "name": "..." } } // Hata yanıtı { "error": { "code": "UNAUTHORIZED", "message": "Geçerli bir oturum gerekli" } }

const res = await fetch( 'https://www.kolaystartup.com/api/public/v1/industries', { headers: { 'X-Api-Key': process.env.KS_DEV_KEY ?? '' } }, ); const { data } = await res.json(); console.log(data);