Руководства

Экспорт и сохранение

Strokka API предоставляет экспорт в JSON (POST /companies/export) — основной способ получить полные контакты через API. Поиск бесплатен; кредиты списываются только при экспорте.

Быстрый старт

Code
# 1. Найти компании (бесплатно, контакты с маской)
curl -sS --get "https://app.strokka.com/api/v1/companies" \
  --data-urlencode "search=маркетинговое агентство" \
  --data-urlencode "searchMode=hybrid" \
  --data-urlencode "limit=10"

# 2. Экспортировать без маски — подставьте id из ответа и ключ из Настройки → API
curl -sS -X POST "https://app.strokka.com/api/v1/companies/export" \
  -H "Content-Type: application/json" \
  -d '{
    "companyIds": [123456, 789012],
    "key": "ваш_secretKey"
  }'

Параметры POST /v1/companies/export

Поле	Тип	Обязательное	Описание
companyIds	integer[]	Да	Массив ID компаний (не пустой)
key	string	Да	API-ключ из Настройки → API
exclude	string[]	Нет	Домены для исключения из выдачи

Ответ

Code
{
  "companies": [
    {
      "id": 1,
      "name": "ООО «Пример»",
      "domain": "example.com",
      "email": "info@example.com",
      "phone": "+7 (495) 123-45-67"
    }
  ],
  "creditsUsed": 1,
  "creditsRemaining": 9999
}

Лимиты на companyIds и exclude

Вопрос	Ответ
Можно передать 5 000 ID за раз?	Да — один запрос с массивом из 5 000 элементов
Нужно ли делить на батчи?	Не обязательно. Батчи удобны для контроля прогресса или при нестабильной сети
Можно передать 3 000 доменов в exclude?	Да — жёсткого лимита на exclude нет
Сколько стоит?	1 кредит = 1 фактически возвращённая компания (после фильтрации exclude)

Практические рекомендации

• Один большой запрос — проще всего, если сеть стабильна и хватает кредитов
• Батчи по 1000–2000 — если хотите логировать прогресс или обрабатывать ошибки по частям
• Проверяйте баланс перед массовым экспортом: creditsRemaining в ответе предыдущего запроса

Массовая выгрузка

Для выборок в тысячи компаний: соберите id постранично (limit до 1000, skip увеличивается), затем один export или батчи.

Пошаговые сценарии с curl:

• Массовая выгрузка — 5000 компаний, один запрос vs батчи
• Повторная выгрузка — exclude и дедупликация

Повторная выгрузка с exclude

Параметр exclude — массив доменов. Компании с этими доменами не возвращаются и не тарифицируются.

Code
curl -sS -X POST "https://app.strokka.com/api/v1/companies/export" \
  -H "Content-Type: application/json" \
  -d '{
    "companyIds": [1, 2, 3, 4, 5],
    "key": "ваш_secretKey",
    "exclude": ["example.com", "test.ru"]
  }'

Подробный сценарий с двумя подходами — в Повторная выгрузка.

Система кредитов

Логика списания

1. Проверяются API-ключ и активная подписка
2. Загрузка компаний с view = TRUE
3. Применяется exclude (если передан)
4. Если строк 0 → 404, баланс не меняется
5. Списание ровно за число возвращённых карточек
6. При нехватке баланса → 402

Тестовые кредиты

1. Зарегистрируйтесь на app.strokka.com/sign-up
2. Получите ключ: аватар → Настройки → API
3. Напишите на vlad@strokka.com — начислим кредиты для тестирования

Фильтры и поиск можно тестировать бесплатно без кредитов.

Коды ошибок

Код	Когда	Пример detail
401	Неверный или отозванный ключ	"Invalid or revoked API key."
402	Недостаточно кредитов	"Insufficient credits. Required: 5, Available: 2"
403	Нет активной подписки	"No active subscription found."
404	Компании не найдены (кредиты не списаны)	"No companies found"
422	Ошибка валидации тела	Пустой key или companyIds

Сохранение в CSV (POST /v1/companies/save)

Эндпоинт для веб-приложения Strokka (требует заголовок x-user-id из сессии). Для внешних интеграций используйте /export.