LocalSERP Proxy API belgeleri

Kimlik doğrulama

Herkese açık katalog dışındaki her istek bir API anahtarı taşır: Authorization: Bearer API_KEY. Anahtar, oluşturduğunuzda yalnızca bir kez tam olarak gösterilir: parola gibi saklayın. Anahtarı istediğiniz zaman iptal edebilirsiniz; bu anahtarla yapılan istekler artık 401 unauthorized döndürür.

curl -s "https://localserpproxy.com/api/v1/balance" \
  -H "Authorization: Bearer $API_KEY"

İstekler ve yanıtlar

• JSON girdi, JSON çıktı: gövdeli Content-Type: application/json gönderin.
• Büyüyebilen listeler, page (1'den başlar) ve perPage (1–100, varsayılan 20) ile sayfalanır ve { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } } döndürür. Kısa listeler { "data": [...] } döndürür.
• Kimlikler, tür öneki olan opak dizelerdir: ord_ (sipariş), top_ (bakiye yükleme), txn_ (bakiye hareketi), res_ (trafik aboneliği), mob_ (mobil port), key_ (API anahtarı) ve ipw_ (IP izin listesi kaydı).
• Güvenli yeniden denemeler: POST /v1/orders ve POST /v1/topups, Idempotency-Key başlığını kabul eder (herhangi bir benzersiz dize, 24 saat saklanır). Aynı anahtarla yeniden gönderim yapıldığında, iki kez satın alma veya bakiye yükleme yerine ilk yanıt döndürülür.
• Örnekler her yanıtın yapısını gösterir: örneklerdeki kimlikler, IP'ler, tutarlar ve tarihler açıklama amaçlıdır; plan kimlikleri ve fiyatlar gerçektir.

Hatalar

Tüm hataların gövdesi aynıdır. code sabittir ve kodunuz tarafından kullanılmak üzere tasarlanmıştır; message değişebilen İngilizce bir cümledir. Doğrulama hatalarında geçersiz her alan fields içinde listelenir. Yeni kodlar eklenebilir: bilinmeyen kodları genel bir hata olarak ele alın.

{
  "error": {
    "code": "validation_failed",
    "message": "Some fields are invalid.",
    "fields": [
      {
        "field": "amountUsd",
        "code": "too_small",
        "message": "The minimum top-up is 25.00 USD."
      }
    ],
    "requestId": "req_2b7c0f"
  }
}

İstek sınırları

Her yanıt RateLimit-Limit, RateLimit-Remaining ve RateLimit-Reset içerir. Sınır aşıldığında API, Retry-After başlığıyla (saniye cinsinden) 429 rate_limited yanıtını verir: belirtilen süre kadar bekleyip yeniden deneyin. Mobil portun IP adresi en fazla 30 saniyede bir değiştirilebilir (429 rotation_too_soon, Retry-After ile).