API Belgeleri

Bu, REST mimarisi etrafında inşa edilen mevcut API uç noktaları için belgelendirmedir. Tüm API uç noktaları, standart HTTP yanıt kodları ile birlikte bir JSON yanıtı döndürecektir ve bir API Anahtarı aracılığıyla Bearer Kimlik Doğrulaması gerektirir.

Get your own API Key

Temel URL

Kimlik doğrulama

Tüm API uç noktaları, Bearer Kimlik Doğrulama yöntemiyle gönderilen bir API anahtarı gerektirir.

Authorization: Bearer {api_key}

Örnek

curl --request GET \
--url 'https://gir.gg/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

Örnek

{
    "errors": [
        {
            "title": "API'ye eri\u015fiminiz yok.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

All API endpoint results work with the UTC timezone unless specified otherwise.

User

Links

Links statistics

Splash pages

QR kodları

Veri

Notification handlers

Özel alan adları

Hesap ödemeleri

Hesap günlükleri