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