Felo API PlatformFelo API Platform
Tất cả endpoint của Apollo
v0.2.0-beta
OpenAPI 3.1.0

Làm giàu dữ liệu người hàng loạt

Máy chủ:https://openapi.felo.ai
Thư viện client

Apollo

​

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

Làm giàu dữ liệu người hàng loạt

​

Làm giàu những người được liệt kê trong mảng details của body yêu cầu. Dùng các trường chi tiết và điều khiển làm giàu được ghi trong tài liệu của endpoint này; không suy ra hợp đồng đầu vào của endpoint một người từ yêu cầu hàng loạt này. Yêu cầu quyền quản trị Felo.

Tham chiếu giá

  • Đo lường: Đơn vị phản hồi được đo lường.
  • Ước tính tham chiếu cho mỗi yêu cầu: USD 1.7775.
  • Cơ sở chi phí đơn vị: USD 0.0.
  • Đơn vị tài nguyên: provider_credit.
  • Hệ số khách hàng tham chiếu: 1.0. Không áp dụng lại cho số tiền khách hàng đã quyết toán.
  • Cơ sở chi phí không xác lập giá cuối cùng cho khách hàng, kể cả khi bằng 0.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

Tham số truy vấn
  • reveal_phone_number
    Kiểu: boolean
  • run_waterfall_email
    Kiểu: boolean
  • run_waterfall_phone
    Kiểu: boolean
  • webhook_url
    Kiểu: string
    độ dài tối thiểu:  
    1
    độ dài tối đa:  
    2048
    Định dạng: https_url
Phần thân
bắt buộc
application/json
  • details
    Kiểu: array object[]
    bắt buộc

    Cung cấp thông tin cho từng người bạn muốn làm giàu dữ liệu dưới dạng một đối tượng trong mảng này. Thêm tối đa 10 người.

    Một người cần làm giàu dữ liệu. Cung cấp bất kỳ định danh nào bạn có — càng nhiều càng dễ khớp.

    • domain
      Kiểu: string

      Tên miền của nhà tuyển dụng của người đó, không có www. Ví dụ: apollo.io

    • email
      Kiểu: string

      Địa chỉ email của người đó.

    • first_name
      Kiểu: string

      Tên, dùng cùng với last_name. Ví dụ: tim

    • hashed_email
      Kiểu: string

      Mã băm MD5 hoặc SHA-256 của địa chỉ email.

    • id
      Kiểu: string

      ID người của Apollo, ví dụ từ tìm kiếm người.

    • last_name
      Kiểu: string

      Họ, dùng cùng với first_name. Ví dụ: zheng

    • linkedin_url
      Kiểu: string

      URL hồ sơ LinkedIn của người đó.

    • name
      Kiểu: string

      Họ tên đầy đủ, ví dụ "tim zheng"; thay thế first_name + last_name.

    • organization_name
      Kiểu: string

      Tên nhà tuyển dụng của người đó. Ví dụ: apollo

Phản hồi
  • 200
    Kiểu: object

    Phản hồi thành công

    • credits_consumed
      Kiểu: integer

      Trường phản hồi

    • error_code
      Kiểu: string

      Trường phản hồi

    • error_message
      Kiểu: string

      Trường phản hồi

    • matches
      Kiểu: array string[]

      Mảng phản hồi

    • missing_records
      Kiểu: integer

      Trường phản hồi

    • status
      Kiểu: string

      Trường phản hồi

    • total_requested_enrichments
      Kiểu: integer

      Trường phản hồi

    • unique_enriched_records
      Kiểu: integer

      Trường phản hồi

    • waterfall
      Kiểu: object

      Đối tượng phản hồi

    application/json
  • 400

    Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.

  • 401

    Cần có khóa API Felo hợp lệ.

  • 402

    Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.

  • 403

    Tài khoản không được phép thực hiện thao tác này.

  • 429

    Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.

  • 502

    Dịch vụ không thể hoàn tất yêu cầu.

  • 503

    API hoặc dịch vụ thanh toán tạm thời không khả dụng.

  • 504

    Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.

  • default

    Phản hồi lỗi; phản hồi chuyển tiếp từ thượng nguồn có thể dùng định dạng của nhà cung cấp

    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