Початок роботи з Grinfi API

Публічний API Grinfi дозволяє безшовно під'єднати платформу до ваших власних інструментів: CRM-систем, внутрішніх дашбордів, no-code платформ (на кшталт Make чи Zapier) або кастомних скриптів.

Майже все, що ви робите у вебзастосунку Grinfi, доступне і через API: керування контактами, запуск автоматизацій, надсилання повідомлень у LinkedIn та Email, а також налаштування вебхуків для відстеження подій у реальному часі.

У цій статті ми розглянемо базові кроки: як створити свій перший API-ключ, зробити тестовий запит та які можливості загалом відкриває наш API.

Крок 1. Створення API-ключа

Для початку роботи вам знадобиться унікальний ключ доступу:

1. Увійдіть у свій акаунт Grinfi за адресою leadgen.grinfi.io.

2. Відкрийте загальні налаштування та перейдіть до розділу Settings -> API Keys.

3. Скопіюйте вже існуючий ключ або натисніть кнопку для створення нового.

🟡 Важливі нюанси безпеки та доступу:

• Кожен API-ключ жорстко прив'язаний до тієї команди (робочого простору), яка була активною на момент його створення. Усі запити з цим ключем матимуть доступ до контактів, автоматизацій та повідомлень виключно цієї команди.

• Тримайте ваш API-ключ у секреті. Будь-хто, хто має до нього доступ, отримує контроль над даними вашого акаунта. Якщо ключ випадково скомпрометовано - негайно видаліть його та згенеруйте новий.

Крок 2. Створення запиту

Базова адреса для всіх API-запитів: https://leadgen.grinfi.io. Кожен ваш запит обов'язково має містити ключ у заголовку авторизації: Authorization: Bearer ВАШ_API_КЛЮЧ.

Для швидкої перевірки роботи API спробуйте виконати пошук контактів у вашому акаунті за допомогою цього cURL-запиту:

curl -X POST "https://leadgen.grinfi.io/leads/api/leads/search" \
-H "Authorization: Bearer ВАШ_API_КЛЮЧ" \
-H "Content-Type: application/json" \
-d '{"filter": {}, "limit": 5, "offset":0}'

Якщо все налаштовано правильно, у відповідь ви отримаєте JSON із першими п'ятьма контактами з вашої CRM.

💡 Дві речі, які варто запам'ятати при роботі з запитами:

• Завжди надсилайте заголовок Content-Type: application/json. Запити у форматі form-encoded не пройдуть валідацію системою.

• Великі списки даних віддаються посторінково за допомогою параметрів limit та offset. У відповіді сервера завжди є поля total і has_more, щоб ви точно знали, коли зупинити парсинг сторінок.

Що вміє API Grinfi

Наш API логічно поділений на чотири основні розділи:

Найпопулярніші сценарії використання API:

• Синхронізація з вашою CRM: Створюйте або оновлюйте контакти разом із кастомними полями за допомогою одного виклику POST /leads/api/leads/upsert.

• Додавання контактів в автоматизації: Програмно додавайте контакти у запущену послідовність (наприклад, одразу після заповнення лід-форми на вашому сайті).

• Пряме надсилання повідомлень: Надсилайте повідомлення в LinkedIn або на Email конкретному контакту безпосередньо з вашого власного воркфлоу.

• Реакція на події в реальному часі: Налаштуйте вебхук і отримуйте HTTP-виклик щоразу, коли контакт відповів, змінив статус або був збагачений новими даними.

• Масовий імпорт та експорт: Завантажуйте CSV-файли для масового імпорту бази або ставте в чергу вивантаження контактів і компаній.

Поширені питання (FAQ)

Отримую помилку 401 або 403. Що робити? Це означає, що ключ відсутній у запиті, є недійсним або його термін дії закінчився. Перевірте, чи коректно передається заголовок Authorization: Bearer, і за потреби згенеруйте новий ключ у розділі API Keys.

Чи є ліміти на кількість запитів (Rate Limits)? Так, тому ми рекомендуємо використовувати пагінацію та налаштовувати розумну частоту запитів. Для масових операцій з даними набагато ефективніше використовувати спеціальні ендпоінти mass-action та інструменти CSV-імпорту/експорту замість циклу з десятків окремих дрібних викликів.

Повна документація

Ця стаття - лише базовий огляд можливостей. Повний технічний довідник API, який містить усі ендпоінти, детальні схеми запитів та приклади відповідей сервера, доступний за посиланням: [Grinfi API Documentation].