Опис:
- Що таке API і як він працює
- Переваги Snov.io API
- Як перевірити Snov.io API
Крок 1. Реєстрація в Postman
Крок 2. Загальні налаштування виклику API
Крок 3. Отримання токена доступу API
Крок 4. Здійснення тестового виклику API - Виклики Snov.io API
- Обмеження Snov.io API
Автоматизувати задачі доволі легко — для цього вам необіхно інтегрувати Snov.io безпосередньо у свою платформу, а ми зі свого боку надаватимемо email-адреси з нашої бази даних. Snov.io REST API робить все можливим!
Що таке API і як він працює
Давайте швидко пройдемося по основах API, познайомимося з тим, що це взагалі таке і як він працює.
API розшифровується як прикладний програмний інтерфейс (Application Programming Interface) і використовується для зв’язку одного програмного забезпечення з іншим. Це такий собі спосіб спілкування та взаємодії двох програм, який передбачає передачу даних та функцій на запит.
Щоб уявити, що таке API на конкретному прикладі, давайте уявимо чат. Так, звичайний чат, де одна програма або програмне забезпечення запитує щось у іншої програми та отримує відповідь у режимі реального часу. А єдиний спосіб спілкуватися в цьому чаті — надсилати заздалегідь визначені «запитання» або «команди» (виклики API), тоді як сервер надсилає відповідь.
Таким чином, виклик API — це процес, за допомогою якого клієнт (ви) надсилає запит до API сервера (Snov.io) і отримує відповідь.
Чотири найпоширеніші методи запиту API:
- GET — отримати дані з сервера за вказаною URL-адресою;
- POST — відправити дані на сервер;
- DELETE — видалити ресурс за вказаною URL-адресою;
- PUT — надіслати дані для створення або оновлення ресурсу.
Якщо клієнт (ви) ставить правильне запитання з правильними параметрами, сервер (Snov.io) поверне дані, що запитуються, або відповідь, яка підтверджує виконання запитаної дії.
Переваги Snov.io API
Snov.io API надає чудову можливість розширити функціональність вашого додатка або вебсайту.
За допомогою Snov.io API ви можете:
- налаштувати кастомну інтеграцію Snov.io з вашим додатком або CRM;
- отримати дані від Snov.io та поповнити свій сервіс додатковою інформацією;
- ініціювати дії, пов’язані з керуванням потенційними клієнтами (наприклад, створити новий список контактів, додати ліда до списку тощо);
- скористатися перевагами пошуку та верифікації email-адрес;
- отримати статистичну інформацію про свої тригерні email-кампанії.
Тип Snov.io API — REST, що робить його надзвичайно простим у користуванні. У REST API дані та функції представлені у вигляді ресурсів, що доступні як унікальні URL-адреси. Щоб попросити Snov.io поділитися даними через API, вам просто потрібно ввести URL-адресу, встановити параметри запиту та автентифікувати його.
Як перевірити Snov.io API
Найпростіший спосіб побачити, як працює Snov.io API, — це скористатися тестовим інструментом. Аби продемонструвати роботу Snov.io API, ми використовуватимемо Postman, оскільки цей інструмент добре відомий, відносно простий у використанні та має безплатну версію.
Давайте зробимо ваш перший виклик API до Snov.io від Postman!
Крок 1. Реєстрація в Postman
Зареєструйтеся в Postman на офіційному веб-сайті та створіть обліковий запис.
У вкладці «Home» (1) натисніть кнопку «Send a request» (2), щоб перейти до середовища тестування API.
Крок 2. Загальні налаштування виклику API
Кожен запит до Snov.io API містить:
- метод запиту — POST або GET (1);
- URL — HTTPS-адреса запиту (2);
- вхідні параметри (Input parameters) — ключ і його значення (3);
- вихід/відповідь (Output/Response) — запитувані дані або відповідь на запит (4).
Ось де ввести налаштування виклику API в середовищі тестування Postman:
Порада: для запитів GET введіть вхідні параметри у вкладці «Params». Для запитів POST введіть вхідні параметри у вкладці «Body»→ вкладка «form-data».
Крок 3. Отримання токена доступу API
Перш ніж зробити запит, вам необхідно згенерувати токен доступу для автентифікації ваших майбутніх викликів API до Snov.io та ідентифікувати себе як клієнта Snov.io у «чаті» Snov.io API.
Токен доступу — це ваша особиста «пропускна картка», яку вам потрібно пред’являти щоразу, коли ви здійснюєте виклик через API до Snov.io.
У кожному запиті до Snov.io API цей токен доступу потрібно вказувати в полі «Autorization» (нижче ми пояснюємо, як це зробити в Postman).
Налаштування виклику токена доступу API:
- (1) Type: POST
- (2) Request URL: https://api.snov.io/v1/oauth/access_token
- Вхідні параметри:
| Ключ | Значення |
| grant_type (1) | client_credentials |
| client_id (2) | ID користувача, який ви можете знайти в налаштуваннях акаунту |
| client_secret (3) | Ключ API, який ви можете знайти в налаштуваннях акаунту |
Після того, як ви ввели всі параметри, клікніть «Send» (1) та отримайте токен доступу (Access token) (2) у розділі «Output/Reponse». Збережіть його або скопіюйте, щоб надалі використовувати його для викликів API.
Примітка №1. В цілях безпеки тривалість існування токену доступу обмежена 3600 секундами (1 година). Вам буде необхідно щогодини генерувати новий токен доступу.
Примітка №2. Тип токену — Bearer. Вам буде необхідно уточнити тип токену під час авторизації наступного запиту.
Тепер ознайомимося з кількома викликами API, які ви можете відправити в Snov.io API.
Крок 4. Здійснення тестового виклику API
- Пошук за доменом V.2
Ви можете попросити Snov.io API надати до 100 email-адрес з домену за один виклик. Вартість становить 1 кредит за 10 email-адрес/потенційних клієнтів, наданих у відповідь.
Щоб автентифікувати свій виклик API у Postman:
Перейдіть на вкладку «Authorization» (1) у Postman, виберіть тип токену «Bearer Token» (2) і вставте токен доступу (3).
Поверніться до вкладки «Params», щоб ввести налаштування виклику API «Пошук за доменом»:
- (1) Type: GET
- (2) Request URL: https://api.snov.io/v2/domain-emails-with-info
- (3) Input parameters (вхідні параметри):
| Ключ | Значення |
| domain | Домен, з якого ви хочете отримати email-адреси. |
| type | Усі, персональні, чи загальні. |
| limit | Кількість адрес, яку ви хочете отримати з домену (максимальне значення складає 100). |
| lastId | Значення за замовчуванням — 0. Щоб отримати понад 10 адрес пошти з домену, у наступному запиті укажіть значення відповіді last_id з попереднього запиту. |
| position or positions | Укажіть конкретні посади, щоб відфільтрувати контакти. |
Примітка № 1. Якщо ви даєте запит на загальні email-адреси, ви отримаєте адреси на основі посад, наприклад contact@snov.io. Особисті адреси електронної пошти – це email-адреси людей, які працюють у компанії. Якщо ви вкажете «all» як тип, ви отримаєте як особисті, так і загальні email-адреси.
Примітка №2. Щоб отримати понад 100 email-адрес з домену, у своєму наступному запиті вкажіть значення відповіді last_id з попереднього запиту.
Після введення всіх налаштувань натисніть кнопку «Send», щоб побачити адреси пошти, які має Snov.io.
- Верифікація адрес
За допомогою Snov.io API ви можете перевірити, чи валідні вказані адреси пошти. Цей виклик API безплатний.
Спочатку переконайтеся, що ви автентифікували свій виклик API за допомогою токена доступу у вкладці «Authorization».
Далі відкрийте вкладку «Body»→ вкладку «form data» в Postman і введіть параметри виклику API «Верифікація адрес»:
- (1) Тип: POST
- (2) Request URL: https://api.snov.io/v1/get-emails-verification-status
- (3) Input parameters (вхідні параметри):
Ключ: emails[]; Значення — масив (список) email-адрес, які вам необхідно перевірити.
Після введення всіх параметрів натисніть кнопку «Send», щоб побачити статус email-адреси в розділі «Output/Response»: «valid», «not_valid», «greylisted» або «unknown».
Якщо ви отримуєте ідентифікатор «not_verified» у полі «Output/Response», це означає, що ми ще не перевіряли цю email-адресу. Ви повинні скористатися викликом API «Додати адреси для перевірки», щоб верифікувати цю адресу пошти (1 кредит за одну адресу), а потім повторити виклик API «Верифікація адрес» (безплатно), щоб побачити результати перевірки.
Виклики Snov.io API
Усі виклики Snov.io API працюють так – ви вводите URL-адресу, вхідні параметри та свій токен доступу, щоб отримати відповідь на конкретний запит:
- Пошук за доменом V.2
- Підрахунок адрес
- Пошук адрес
- Додати імена для пошуку адрес
- Шукати контакт за посиланням на профіль
- Отримати контакт за посиланням на профіль
- Знайти профіль за адресою
Або ініціювати певну дію, наприклад:
- Додати контакт до списку
- Знайти контакт за id
- Знайти контакт за email-адресою
- Знайти кастомні поля контактів
- Перегляд списків користувача
- Перегляд контактів зі списку
- Створення нового списку контактів
Обмеження Snov.io API
У Snov.io API діють певні обмеження на кількість допустимих викликів на хвилину та годину.
Максимальна кількість запитів на хвилину становить 60.
Обмеження на годину залежать від вашого тарифного плану:
Ліміти на пошук email-адрес через API:
- Starter — 200 запитів/година
- Pro 5K — 400 запитів/година
- Pro 20K — 600 запитів/година
- Pro 50K — 800 запитів/година
- Pro 100K — 1000 запитів/година
Ліміти на верифікацію email-адрес через API:
- Starter — 500 запитів/година
- Pro 5K — 1000 запитів/година
- Pro 20K — 1400 запитів/година
- Pro 50K — 2000 запитів/година
- Pro 100K — 4000 запитів/година
Ознайомтеся з усіма доступними викликами API, параметрами, вартістю в кредитах та лімітами у нашій документації API.
Не маєте власної програми, щоб підʼєднати до Snov.io через API, та все ж користуєтеся іншими корисними інструментами та хочете інтегрувати їх зі Snov.io? Дізнайтеся, як це зробити за допомогою Zapier.
Потрібен доступ до Snov.io API? Напишіть нашій команді підтримки та призначте онлайн-зустріч, щоб ознайомитися зі Snov.io API.