Felo API PlatformFelo API Platform
جميع endpoints الخاصة بـ 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