Przegląd

API Mapfolio zapewnia programowy dostęp do danych szwajcarskich firm poprzez interfejs RESTful. Wszystkie punkty końcowe są udokumentowane przy użyciu specyfikacji OpenAPI 3.0, zapewniając spójność i łatwość integracji.

Rozpoczęcie

Uwierzytelnianie

API Mapfolio używa uwierzytelniania za pomocą klucza API. Możesz uzyskać swój klucz API w ustawieniach konta.

Nagłówek klucza API:

X-API-Key: mapf_twoj_klucz_api_tutaj

Token Bearer (Alternatywa):

Authorization: Bearer mapf_twoj_klucz_api_tutaj

URL bazowy

Wszystkie żądania API powinny być wysyłane do:

https://mapfolio.app

Ograniczenie przepustowości

Żądania API są ograniczone przepustowością, aby zapewnić sprawiedliwe wykorzystanie:

Żądania uwierzytelnione: 1000 żądań na godzinę na klucz API
Żądania nieuwierzytelnione: 10 żądań na godzinę na adres IP

Informacje o ograniczeniu przepustowości są zawarte w nagłówkach odpowiedzi:

X-RateLimit-Limit: Maksymalna liczba dozwolonych żądań
X-RateLimit-Remaining: Pozostałe żądania w bieżącym oknie
X-RateLimit-Reset: Znacznik czasu Unix, gdy limit jest resetowany

Dostępne punkty końcowe

Wyszukiwanie firm

Wyszukuj firmy z zaawansowanymi opcjami filtrowania:

Wyszukiwanie tekstowe w nazwach firm
Filtrowanie według kantonu (kantony szwajcarskie)
Filtrowanie według statusu firmy
Obsługa paginacji

Szczegóły firmy

Pobierz szczegółowe informacje o konkretnych firmach:

Dane profilu firmy
Informacje o lokalizacji
Status prawny
Szczegóły rejestracji

Statystyki

Uzyskaj dostęp do zagregowanych statystyk dotyczących szwajcarskich firm:

Całkowite liczby firm
Statystyki na poziomie kantonu
Rozkłady oparte na literach
Liczby kombinacji dwóch liter

Autouzupełnianie

Otrzymuj sugestie autouzupełniania dla:

Nazw firm
Miast
Kodów pocztowych

Losowe firmy

Pobierz losowe próbki firm do testów i eksploracji.

Format odpowiedzi

Wszystkie udane odpowiedzi API następują spójnej strukturze:

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

Odpowiedzi błędów zawierają szczegółowe informacje:

{
  "error": "Komunikat błędu",
  "details": "Dodatkowe szczegóły błędu"
}

Kody błędów

400 Bad Request: Nieprawidłowe parametry żądania
401 Unauthorized: Brakujący lub nieprawidłowy klucz API
403 Forbidden: Niewystarczające uprawnienia
404 Not Found: Zasób nie znaleziony
429 Too Many Requests: Przekroczony limit przepustowości
500 Internal Server Error: Błąd serwera

Specyfikacja OpenAPI

Pełna specyfikacja OpenAPI 3.0 jest dostępna pod adresem:

Interaktywna dokumentacja: /api-docs.html
OpenAPI JSON: /api/docs/openapi.json

Możesz użyć specyfikacji OpenAPI z dowolnym kompatybilnym narzędziem:

Swagger UI
Postman
Insomnia
Generatory kodu dla bibliotek klienckich

Przykłady kodu

cURL

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

JavaScript (Fetch)

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

Python (Requests)

import requests

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

Wsparcie

W przypadku wsparcia API i pytań:

Dokumentacja: Odwiedź interaktywną dokumentację API
Email: support@mapfolio.app
Problemy: Zgłoś problemy przez panel swojego konta

Warunki użytkowania

Korzystając z API Mapfolio, zgadzasz się z naszymi Warunkami świadczenia usług i Polityką prywatności. Proszę przejrzeć limity przepustowości i wytyczne dotyczące użytkowania, aby zapewnić zgodność.