Як використовувати метод API “Пошук за доменом”

У цій статті описано метод API пошуку за доменом Snovio, загальний процес його використання, доступні запити, їхні параметри та відповіді.

Це версія API інструменту пошуку за доменом у програмі Snov.io. Він надає ті самі параметри пошуку через запити API. Використовуючи API, ви можете запитувати та отримувати інформацію про компанії та їхні контакти (адреси та профілі потенційних клієнтів) на основі наданих доменів.

Давайте розглянемо кінцеві точки, доступні в Domain Search API, їх призначення в загальному робочому процесі та розглянемо їхні основні параметри.

learn
Перш ніж робити будь-який запит до Snov.io, використовуйте кінцеву точку автентифікації, щоб отримати access_token. Використовуйте його як маркер типу носія для наступних запитів. Тривалість життя access_token становить 1 годину (3600 секунд).

Пошук за доменом (запит інформації про компанію)

Тип запиту: POST

URL-адреса запиту: https://api.snov.io/v2/domain-search/start/

Це базова кінцева точка, яка надсилає запит до API Snov.io для пошуку інформації про компанію за наданим доменом.

Вхідні параметри:

У полі “domain” для цього запиту введіть доменне ім’я (сайт компанії), за яким потрібно виконати пошук.

Відповідь містить два ключових пункти:

  • Унікальний “task_hash”, який ідентифікує ваш запит. Ви використаєте його в наступному запиті, щоб отримати результати пошуку.
  • Пряма URL-адреса (у полі “result”) для отримання результатів пошуку (отримання інформації про компанію).

Пошук за доменом (отримати інформацію про компанію)

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/domain-search/result/{task_hash}

Використовуйте цей запит, щоб отримати результати пошуку, згенеровані попереднім запитом.

Вхідні параметри: цей запит не вимагає жодних параметрів. Додайте “task_hash” до URL-адреси або скористайтеся прямим посиланням, наданим у попередній відповіді.

Відповідь на цей запит містить:

  • Інформація про компанію (локація, сайт, назва, номер телефону головного офісу, галузь, розмір тощо).
  • Кількість контактів за типом (потенційні клієнти, адреси з домену, загальні контакти).
learn

У полі “links” відповіді ви знайдете прямі URL-адреси для пошуку та фільтрації контактів за типом: “prospects”, “domain_emails”, “generic_contacts”. Використовуйте ці URL-адреси для наступних запитів.

Шукати контакти за доменом

Тип запиту: POST

URL-адреса запиту: https://api.snov.io/v2/domain-search/prospects/start?domain=

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

Вхідні параметри:

У полі “domain” для цього запиту введіть доменне ім’я (сайт компанії), за яким потрібно виконати пошук.

Використовуйте параметр “page”, щоб указати, на якій сторінці результатів ви хочете шукати потенційних клієнтів.

Пагінація в результатах API: за замовчуванням будь-який запит без параметра “page” автоматично шукає на першій сторінці результатів. Для пошуку на іншій сторінці вкажіть її номер у параметрах запиту.

learn

У параметрі “positions” перелічіть назви посад, за якими ви хочете відфільтрувати, у вигляді масиву (максимум 10). Помістіть їх у квадратні дужки, розділивши їх комами. Наприклад: positions[]: [Developer, Product Manager, Software Engineer]

Відповідь містить два ключових пункти:

  • Унікальний “task_hash”, який ідентифікує ваш запит. Ви використаєте його в наступному запиті, щоб отримати результати пошуку.
  • Пряма URL-адреса для наступного запиту (у полі “results”) для отримання результатів пошуку.

Отримати контакти з домену

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/domain-search/prospects/result/{task_hash}

Використовуйте цей запит, щоб отримати результати пошуку потенційних клієнтів, згенеровані попереднім запитом.

Вхідні параметри: цей запит не вимагає жодних параметрів. Додайте “task_hash” до URL-адреси або скористайтеся прямим посиланням, наданим у попередній відповіді.

Відповідь на цей запит містить:

Відповідь містить детальну інформацію про проспекти, знайдені в домені. Кожен потенційний клієнт містить такі поля:

  • “first_name”
  • “last_name”
  • “position”
  • “source_page”
  • “search_emails_start”

Розбивка на сторінки в результатах API: кожен запит повертає результати для однієї сторінки. Якщо ви не вказали параметр “page” у своєму попередньому запиті, за замовчуванням повертається перша сторінка.

Поле “total_count” показує загальну кількість потенційних клієнтів для домену. Якщо доступно більше сторінок, ви побачите поле “next” з URL-адресою для отримання наступної сторінки результатів.

tip

Важливо: адреси не включені у відповідь на цей запит.

Щоб знайти email-адресу потенційного клієнта, скористайтеся URL-адресою, наданою в полі “search_emails_start” для цього потенційного клієнта. Посилання містить унікальний “prospect_hash” для кожного потенційного клієнта. До кожного потенційного клієнта надсилається окремий запит.

Шукати адресу контакта 

Тип запиту: POST

URL-адреса запиту: https://api.snov.io/v2/domain-search/prospects/search-emails/start/{prospect_hash}

Використовуйте цей запит, щоб знайти адресу електронної пошти потенційного клієнта (повернуто в результатах попереднього запиту Отримати контакти із домену).

Вхідні параметри:

Цей запит не потребує додаткових параметрів. Унікальний “prospect_hash” (prospect-id) автоматично додається до URL-адреси, використовуючи значення з поля “search_emails_start” у попередній відповіді.

Відповідь містить два ключових пункти:

  • Унікальний “task_hash”, який ідентифікує ваш запит. Ви використаєте його в наступному запиті, щоб отримати результати пошуку.
  • Пряма URL-адреса для наступного запиту (у полі “results”) для перевірки статусу пошуку та отримання email-адреси потенційного клієнта.

Отримати адресу контакта

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/domain-search/prospects/search-emails/result/{task_hash}

Використовуйте цей запит, щоб отримати адресу електронної пошти потенційного клієнта, знайденого в попередньому запиті.

Вхідні параметри:

Цей запит не потребує додаткових параметрів. Унікальний “task_hash” автоматично додається до URL-адреси, використовуючи значення з попередньої відповіді.

learn

Якщо пошук все ще триває, відповідь покаже “in_progress”. Коли пошук буде “completed” і адреса буде знайдена, вона буде включена у відповідь.

Відповідь на цей запит містить:

Відповідь на цей запит містить email-адресу потенційного клієнта та його статус верифікації, який може бути valid (зелений) або unknown (жовтий). Детальніше про статуси email-адрес.

Шукати адреси за доменом

Тип запиту: POST

URL-адреса запиту: https://api.snov.io/v2/domain-search/domain-emails/start?domain=

Використовуйте цю кінцеву точку, щоб надіслати запит до Snovio API для пошуку адрес за наданомим доменом.

Email-адреса з домену – це неперевірена адреса електронної пошти, яка належить до домену компанії. Це може бути адреса працівника або загальна адреса пошти.

Вхідні параметри:

У полі “domain” для цього запиту введіть доменне ім’я (сайт компанії), за яким потрібно виконати пошук.

Відповідь містить два ключових пункти:

  • Унікальний “task_hash”, який ідентифікує ваш запит. Ви використаєте його в наступному запиті, щоб отримати результати пошуку.
  • Пряма URL-адреса (у полі “result”) для отримання результатів пошуку.

Отримати адреси з домену

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/domain-search/domain-emails/result/{task_hash}

Використовуйте цей запит, щоб отримати результати пошуку пошти, згенеровані попереднім запитом.

Вхідні параметри: цей запит не вимагає жодних параметрів. Додайте “task_hash” у кінці URL-адреси або скористайтеся прямим посиланням, наданим у попередній відповіді.

learn

Якщо пошук все ще триває, відповідь покаже “in_progress”. Коли пошук буде “completed”, адреси будуть включені у відповідь.

Відповідь на цей запит містить:

У відповіді надається список адрес, знайдених у домені.

Пагінація в результатах API: один запит надає до 50 адрес (одна сторінка результатів). Перша сторінка повертається за умовчанням.

Поле “total_count” у відповіді показує загальну кількість доступних адрес. Якщо доступно більше сторінок, ви отримаєте URL-адресу для отримання наступної сторінки результатів у полі “next”.

Поле “next” у відповіді містить URL-адресу, за допомогою якої можна запитати наступну сторінку результатів.

learn
Зверніть увагу: статус верифікації не включено в цю відповідь. Щоб перевірити адресу з домену, скористайтеся методом верифікації API.

Шукати загальні контакти з домену

Тип запиту: POST

URL-адреса запиту: https://api.snov.io/v2/domain-search/generic-contacts/start

Використовуйте цю кінцеву точку, щоб надіслати запит до Snovio API для пошуку загальних контактів за наданим доменом.

Загальний контакт – це неперевірена адреса з домену компанії, часто це технічні або службові адреси, наприклад info@domain.com.

Вхідні параметри:

У полі “domain” для цього запиту введіть доменне ім’я (сайт компанії), за яким потрібно виконати пошук.

Відповідь містить два ключових пункти:

  • Унікальний “task_hash”, який ідентифікує ваш запит. Ви використаєте його в наступному запиті, щоб отримати результати пошуку.
  • Пряма URL-адреса (у полі “result”) для отримання результатів пошуку.

Отримати загальні контакти з домену

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/domain-search/generic-contacts/result/task_hash

Використовуйте цей запит, щоб отримати результати пошуку, згенеровані попереднім запитом.

Вхідні параметри: цей запит не вимагає жодних параметрів. Додайте “task_hash” у кінці URL-адреси або скористайтеся прямим посиланням, наданим у попередній відповіді.

learn

Якщо пошук все ще триває, відповідь покаже “in_progress”. Коли пошук буде “completed”, результати будуть включені у відповідь.

Відповідь на цей запит містить:

Відповідь надає список загальних контактів пошти, знайдених у домені.

Пагінація в результатах API: один запит надає до 50 контактів (одна сторінка результатів). За замовчуванням повертається перша сторінка.

Поле “total_count” у відповіді показує загальну кількість доступних контактів. Якщо доступно більше сторінок, ви отримаєте URL-адресу для отримання наступної сторінки результатів у полі “next”.

learn
Зверніть увагу: статус верифікації не включено в цю відповідь. Щоб перевірити адресу з домену, скористайтеся методом верифікації API.

Вартість пошуку за доменом в кредитах

Кожен запит типу POST до API пошуку за доменом вираховуватиме один кредит із квоти вашого акаунту.

Запит не призведе до зняття кредитів у таких випадках:

  • Запит не дає жодних результатів (наприклад, у відповіді немає інформації про компанію, потенційних клієнтів або адрес).
  • У пошуковому запиті не знайдено верифікованих (зелених або жовтих) адрес потенційного клієнта.
URL запиту Вартість в кредитах
https://api.snov.io/v2/domain-search 1 кредит за кожен запит із типом “POST”.
https://api.snov.io/v2/domain-search/prospects 1 кредит за кожен запит із типом “POST” (до 20 профілів контактів без адрес за запит).
https://api.snov.io/v2/domain-search/domain-emails 1 кредит за кожен запит із типом “POST” (до 50 неверифікованих адрес із домену за запит).
https://api.snov.io/v2/domain-search/generic-contacts 1 кредит за кожен запит із типом “POST” (до 50 неверифікованих загальних контактів за запит).
https://api.snov.io/v2/domain-search/prospects/search-emails 1 кредит за кожен запит, якщо знайдено валідну (зелену_ або невідому (жовту) адресу. Якщо не знайдено верфиікованих адрес, кредити не списуються.

Читайте повну технічну документацію з пошуку за доменом через API.

Дякуємо за відгук!

Чи була стаття корисною?

Ні

Нам шкода 😢

Як нам покращити статтю?