Felo API PlatformFelo API Platform
Все эндпоинты 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.

Query-параметры
  • 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

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    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

Нужна помощь?