Огляд

API Mapfolio надає програмний доступ до даних швейцарських компаній через RESTful інтерфейс. Всі кінцеві точки документовані з використанням специфікації OpenAPI 3.0, забезпечуючи узгодженість та легкість інтеграції.

Початок роботи

Аутентифікація

API Mapfolio використовує аутентифікацію за допомогою ключа API. Ви можете отримати свій ключ API у налаштуваннях облікового запису.

Заголовок ключа API:

X-API-Key: mapf_your_api_key_here

Токен Bearer (Альтернатива):

Authorization: Bearer mapf_your_api_key_here

Базовий URL

Всі запити API повинні надсилатися на:

https://mapfolio.app

Обмеження швидкості

Запити API обмежені швидкістю для забезпечення справедливого використання:

Аутентифіковані запити: 1000 запитів на годину на ключ API
Неаутентифіковані запити: 10 запитів на годину на IP-адресу

Інформація про обмеження швидкості включена в заголовки відповіді:

X-RateLimit-Limit: Максимальна кількість дозволених запитів
X-RateLimit-Remaining: Залишкові запити в поточному вікні
X-RateLimit-Reset: Мітка часу Unix, коли ліміт скидається

Доступні кінцеві точки

Пошук компаній

Шукайте компанії з розширеними опціями фільтрації:

Текстовий пошук у назвах компаній
Фільтрація за кантоном (швейцарські кантони)
Фільтрація за статусом компанії
Підтримка пагінації

Деталі компанії

Отримайте детальну інформацію про конкретні компанії:

Дані профілю компанії
Інформація про місцезнаходження
Юридичний статус
Деталі реєстрації

Статистика

Отримайте доступ до агрегованої статистики про швейцарські компанії:

Загальна кількість компаній
Статистика на рівні кантону
Розподіли на основі літер
Підрахунки комбінацій двох літер

Автозаповнення

Отримайте пропозиції автозаповнення для:

Назв компаній
Міст
Поштових індексів

Випадкові компанії

Отримайте випадкові зразки компаній для тестування та дослідження.

Формат відповіді

Всі успішні відповіді API слідують узгодженій структурі:

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

Відповіді про помилки містять детальну інформацію:

{
  "error": "Повідомлення про помилку",
  "details": "Додаткові деталі помилки"
}

Коди помилок

400 Bad Request: Недійсні параметри запиту
401 Unauthorized: Відсутній або недійсний ключ API
403 Forbidden: Недостатні дозволи
404 Not Found: Ресурс не знайдено
429 Too Many Requests: Перевищено обмеження швидкості
500 Internal Server Error: Помилка сервера

Специфікація OpenAPI

Повна специфікація OpenAPI 3.0 доступна за адресою:

Інтерактивна документація: /api-docs.html
OpenAPI JSON: /api/docs/openapi.json

Ви можете використовувати специфікацію OpenAPI з будь-яким сумісним інструментом:

Swagger UI
Postman
Insomnia
Генератори коду для клієнтських бібліотек

Приклади коду

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()

Підтримка

Для підтримки API та питань:

Документація: Відвідайте інтерактивну документацію API
Email: support@mapfolio.app
Проблеми: Повідомте про проблеми через панель вашого облікового запису

Умови використання

Використовуючи API Mapfolio, ви погоджуєтеся з нашими Умовами надання послуг та Політикою конфіденційності. Будь ласка, перегляньте обмеження швидкості та рекомендації щодо використання, щоб забезпечити відповідність.