Felo API PlatformFelo API Platform
Усі endpoint Apollo
v0.2.0-beta
OpenAPI 3.1.0

Масове збагачення людей

Сервер:https://openapi.felo.ai
Клієнтські бібліотеки

Apollo

​

Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.

Масове збагачення людей

​

Збагачує людей, перелічених у масиві details тіла запиту. Використовуйте документовані поля деталей і засоби керування збагаченням цього ендпоінта; не виводьте вхідний контракт ендпоінта для однієї людини з цього пакетного запиту. Потрібні адміністративні дозволи Felo.

Довідкові дані про ціни

  • Тарифікація: тарифіковані одиниці відповіді.
  • Орієнтовна вартість запиту: USD 1.7775.
  • Базова вартість одиниці: USD 0.0.
  • Одиниця ресурсу: provider_credit.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.
  • Базові вартості не визначають остаточну ціну для клієнта, зокрема коли вони дорівнюють нулю.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Параметри запиту
  • reveal_phone_number
    Тип: boolean
  • run_waterfall_email
    Тип: boolean
  • run_waterfall_phone
    Тип: boolean
  • webhook_url
    Тип: string
    мінімальна довжина:  
    1
    максимальна довжина:  
    2048
    Формат: https_url
Тіло
обов'язкове
application/json
  • details
    Тип: array object[]
    обов'язкове

    Передайте відомості про кожну людину, яку потрібно збагатити, як об'єкт у цьому масиві. Додайте до 10 людей.

    Одна людина для збагачення. Укажіть усі ідентифікатори, які маєте, — що їх більше, то вища ймовірність збігу.

    • domain
      Тип: string

      Домен роботодавця людини, без www. Приклад: apollo.io

    • email
      Тип: string

      Адреса email людини.

    • first_name
      Тип: string

      Ім'я, використовується разом з last_name. Приклад: tim

    • hashed_email
      Тип: string

      Хеш MD5 або SHA-256 адреси email.

    • id
      Тип: string

      Apollo person id, наприклад із пошуку людей.

    • last_name
      Тип: string

      Прізвище, використовується разом з first_name. Приклад: zheng

    • linkedin_url
      Тип: string

      URL профілю LinkedIn людини.

    • name
      Тип: string

      Повне ім'я, наприклад "tim zheng"; замінює first_name + last_name.

    • organization_name
      Тип: string

      Назва роботодавця людини. Приклад: apollo

Відповіді
  • 200
    Тип: object

    Успішна відповідь

    • credits_consumed
      Тип: integer

      Поле відповіді

    • error_code
      Тип: string

      Поле відповіді

    • error_message
      Тип: string

      Поле відповіді

    • matches
      Тип: array string[]

      Масив відповіді

    • missing_records
      Тип: integer

      Поле відповіді

    • status
      Тип: string

      Поле відповіді

    • total_requested_enrichments
      Тип: integer

      Поле відповіді

    • unique_enriched_records
      Тип: integer

      Поле відповіді

    • waterfall
      Тип: object

      Об'єкт відповіді

    application/json
  • 400

    Не вдалося обробити запит. Перевірте параметри запиту.

  • 401

    Потрібен дійсний API-ключ Felo.

  • 402

    Запит неможливо виконати: умови білінгу не виконано.

  • 403

    Обліковий запис не має дозволу на цю операцію.

  • 429

    Досягнуто ліміту запитів або витрат.

  • 502

    Служба не змогла виконати запит.

  • 503

    API або служба білінгу тимчасово недоступні.

  • 504

    Час очікування обробки запиту вичерпано.

  • default

    Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

    application/json
Request Example for post/v1/beta/apollo/people/bulk_match
curl https://openapi.felo.ai/v1/beta/apollo/people/bulk_match \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "details": [
    {
      "first_name": "",
      "last_name": "",
      "name": "",
      "email": "",
      "hashed_email": "",
      "organization_name": "",
      "domain": "",
      "id": "",
      "linkedin_url": ""
    }
  ]
}'
{
  "status": "string",
  "error_code": "string",
  "error_message": "string",
  "total_requested_enrichments": 1,
  "unique_enriched_records": 1,
  "missing_records": 1,
  "credits_consumed": 1,
  "matches": [
    "string"
  ],
  "waterfall": {}
}
Bulk People Enrichment