kısaLink API

RESTful API Dokümantasyonu

v1.0.0
Token Auth
Rate Limited
Hızlı Başlangıç
3 adımda API'yi kullanmaya başlayın

1. Token Oluştur

API erişimi için token oluşturun

Token Oluştur

2. İlk İstek

API'ye ilk isteğinizi gönderin

3. Entegre Et

Uygulamanıza entegre edin

GitHub Wiki
Kimlik Doğrulama
API'ye güvenli erişim için token tabanlı kimlik doğrulama

Bearer Token

Tüm API isteklerinde Authorization header'ında Bearer token kullanın.

Authorization: Bearer lks_your_token_here

Güvenlik Uyarısı

Token'ınızı güvenli tutun ve asla public repository'lerde paylaşmayın. Environment variable kullanın.

Rate Limiting
API kullanım limitleri ve kısıtlamaları

Limitler

  • Varsayılan Limit:
    100 req/hour
  • Maksimum Limit:
    1000 req/hour
  • Burst Limit:
    10 req/min

Response Headers

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

API Endpoint'leri

POST
/api/v1/links
links:create
Yeni bir kısaltılmış link oluşturur

Request Body

{
  "originalUrl": "string (required)",
  "customUrl": "string (optional)"
}
originalUrl: string (required) - Kısaltılacak URL
customUrl: string (optional) - Özel kısa URL
GET
/api/v1/links
links:read
Kullanıcının tüm link'lerini listeler

Query Parameters

page: number (optional) - Sayfa numarası (default: 1)
limit: number (optional) - Sayfa başına kayıt (max: 100, default: 10)
GET
/api/v1/links/{id}
links:read
Belirli bir link'in detaylarını getirir
DELETE
/api/v1/links/{id}
links:delete
Belirli bir link'i siler
GET
/api/v1/stats
stats:read
Kullanıcının link istatistiklerini getirir
POST
/api/v1/tokens
tokens:create
Yeni API token oluşturur

Request Body

{
  "name": "string (required)",
  "permissions": "array (required)",
  "rateLimit": "number (optional)",
  "expiresAt": "string (optional)"
}
name: string (required) - Token adı
permissions: array (required) - Token yetkileri
rateLimit: number (optional) - Saatlik limit (default: 100)
expiresAt: string (optional) - Son kullanma tarihi
Hata Kodları
API'nin döndürebileceği hata kodları ve açıklamaları
400
Bad Request
Geçersiz istek parametreleri
401
Unauthorized
Geçersiz veya eksik token
403
Forbidden
Yetersiz yetki
404
Not Found
Kaynak bulunamadı
409
Conflict
Özel URL zaten kullanılıyor
429
Too Many Requests
Rate limit aşıldı
500
Internal Server Error
Sunucu hatası

Error Response Format

{
  "success": false,
  "error": "Error message",
  "message": "Detailed error description"
}
SDK'lar ve Kütüphaneler
Farklı programlama dilleri için örnekler ve kütüphaneler

JavaScript/Node.js

npm install axios

Axios ile HTTP istekleri gönderin

Python

pip install requests

Requests kütüphanesi ile API'ye erişin

PHP

curl veya Guzzle HTTP

cURL veya Guzzle ile HTTP istekleri

Go

net/http package

Standard HTTP client kullanın

Destek ve Topluluk
Yardım almak ve katkıda bulunmak için kaynaklar

GitHub

Kaynak kod ve issue'lar

GitHub'da Görüntüle

Wiki

Detaylı dokümantasyon

Wiki'yi Ziyaret Et

API Tokens

Token yönetimi

Token Yönetimi