API Dokümantasyonu

Mapfolio'nun genel API'si için tam dokümantasyon - İsviçre şirket verilerine programatik erişim

Interactive API Documentation
Explore all available endpoints, request parameters, response schemas, and try out API calls directly in your browser.
View OpenAPI Documentation

Genel Bakış

Mapfolio API, RESTful bir arayüz aracılığıyla İsviçre şirket verilerine programatik erişim sağlar. Tüm endpoint'ler OpenAPI 3.0 spesifikasyonu kullanılarak dokümante edilmiştir, tutarlılık ve entegrasyon kolaylığı sağlar.

Başlarken

Kimlik Doğrulama

Mapfolio API, API anahtarı kimlik doğrulaması kullanır. API anahtarınızı hesap ayarlarınızdan alabilirsiniz.

API Anahtarı Başlığı:

X-API-Key: mapf_your_api_key_here

Bearer Token (Alternatif):

Authorization: Bearer mapf_your_api_key_here

Temel URL

Tüm API istekleri şu adrese yapılmalıdır:

https://mapfolio.app

Hız Sınırlaması

API istekleri adil kullanımı sağlamak için hız sınırlamasına tabidir:

  • Kimlik doğrulanmış istekler: API anahtarı başına saatte 1000 istek
  • Kimlik doğrulanmamış istekler: IP adresi başına saatte 10 istek

Hız sınırlaması bilgileri yanıt başlıklarında yer alır:

  • X-RateLimit-Limit: İzin verilen maksimum istek sayısı
  • X-RateLimit-Remaining: Mevcut penceredeki kalan istekler
  • X-RateLimit-Reset: Limit sıfırlandığında Unix zaman damgası

Mevcut Endpoint'ler

Şirket Arama

Gelişmiş filtreleme seçenekleriyle şirket arayın:

  • Şirket adlarında metin araması
  • Kanton (İsviçre kantonları) ile filtreleme
  • Şirket durumuna göre filtreleme
  • Sayfalama desteği

Şirket Detayları

Belirli şirketler hakkında detaylı bilgi alın:

  • Şirket profil verileri
  • Konum bilgileri
  • Yasal durum
  • Kayıt detayları

İstatistikler

İsviçre şirketleri hakkında toplu istatistiklere erişin:

  • Toplam şirket sayıları
  • Kanton düzeyinde istatistikler
  • Harf tabanlı dağılımlar
  • İki harfli kombinasyon sayıları

Otomatik Tamamlama

Şunlar için otomatik tamamlama önerileri alın:

  • Şirket adları
  • Şehirler
  • Posta kodları

Rastgele Şirketler

Test ve keşif için rastgele şirket örnekleri alın.

Yanıt Formatı

Tüm başarılı API yanıtları tutarlı bir yapı izler:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Hata yanıtları detaylı bilgi içerir:

{
  "error": "Hata mesajı",
  "details": "Ek hata detayları"
}

Hata Kodları

  • 400 Bad Request: Geçersiz istek parametreleri
  • 401 Unauthorized: Eksik veya geçersiz API anahtarı
  • 403 Forbidden: Yetersiz izinler
  • 404 Not Found: Kaynak bulunamadı
  • 429 Too Many Requests: Hız sınırı aşıldı
  • 500 Internal Server Error: Sunucu hatası

OpenAPI Spesifikasyonu

Tam OpenAPI 3.0 spesifikasyonu şu adreste mevcuttur:

OpenAPI spesifikasyonunu herhangi bir uyumlu araçla kullanabilirsiniz:

  • Swagger UI
  • Postman
  • Insomnia
  • İstemci kütüphaneleri için kod üreteçleri

Kod Örnekleri

cURL

curl -H "X-API-Key: mapf_your_api_key_here" \
  https://mapfolio.app/api/search?q=technology

JavaScript (Fetch)

const response = await fetch('https://mapfolio.app/api/search?q=technology', {
  headers: {
    'X-API-Key': 'mapf_your_api_key_here'
  }
})
const data = await response.json()

Python (Requests)

import requests

headers = {'X-API-Key': 'mapf_your_api_key_here'}
response = requests.get(
  'https://mapfolio.app/api/search',
  params={'q': 'technology'},
  headers=headers
)
data = response.json()

Destek

API desteği ve sorular için:

Kullanım Koşulları

Mapfolio API'sini kullanarak Hizmet Şartlarımızı ve Gizlilik Politikamızı kabul etmiş olursunuz. Lütfen uyumluluğu sağlamak için hız sınırlarını ve kullanım yönergelerini gözden geçirin.