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 است.

مرجع قیمت‌گذاری

  • اندازه‌گیری: واحدهای پاسخ اندازه‌گیری‌شده.
  • برآورد درخواست مرجع: 1.7775 دلار آمریکا.
  • مبنای هزینه واحد: 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

      نشانی ایمیل فرد.

    • first_name
      نوع: string

      نام، همراه با last_name استفاده می‌شود. نمونه: tim

    • hashed_email
      نوع: string

      هش MD5 یا SHA-256 نشانی ایمیل.

    • id
      نوع: string

      شناسه فرد در Apollo، مثلاً از جستجوی افراد.

    • 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