Felo API PlatformFelo API Platform
Semua endpoint Apollo
v0.2.0-beta
OpenAPI 3.1.0

Pengayaan Data Orang Pukal

Pelayan:https://openapi.felo.ai
Pustaka Klien

Apollo

​

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

Pengayaan Data Orang Pukal

​

Perkayakan orang yang disenaraikan dalam array details badan permintaan. Gunakan medan butiran dan kawalan pengayaan yang didokumenkan untuk endpoint ini; jangan simpulkan kontrak input endpoint satu orang daripada permintaan pukal ini. Memerlukan kebenaran pentadbir Felo.

Rujukan harga

  • Pemeteran: Unit respons dimeterkan.
  • Anggaran rujukan setiap permintaan: USD 1.7775.
  • Asas kos unit: USD 0.0.
  • Unit sumber: provider_credit.
  • Pengganda pelanggan rujukan: 1.0. Jangan gunakan semula pada amaun pelanggan yang telah diselesaikan.
  • Asas kos tidak menentukan harga pelanggan akhir, termasuk apabila sifar.

Metadata rujukan sahaja, bukan sebut harga akaun, harga terjamin atau had perbelanjaan. Kredit sumber bukan kredit Felo. Caj akhir mengikut rekod pengebilan Felo.

Parameter Pertanyaan
  • reveal_phone_number
    Jenis: boolean
  • run_waterfall_email
    Jenis: boolean
  • run_waterfall_phone
    Jenis: boolean
  • webhook_url
    Jenis: string
    panjang minimum:  
    1
    panjang maksimum:  
    2048
    Format: https_url
Badan
wajib
application/json
  • details
    Jenis: array object[]
    wajib

    Berikan maklumat bagi setiap orang yang ingin anda perkayakan sebagai objek dalam array ini. Tambah sehingga 10 orang.

    Satu orang untuk diperkayakan. Berikan sebarang pengecam yang anda ada — semakin banyak, semakin tinggi kemungkinan padanan.

    • domain
      Jenis: string

      Domain majikan orang itu, tanpa www. Contoh: apollo.io

    • email
      Jenis: string

      Alamat e-mel orang itu.

    • first_name
      Jenis: string

      Nama pertama, digunakan bersama last_name. Contoh: tim

    • hashed_email
      Jenis: string

      Hash MD5 atau SHA-256 bagi alamat e-mel.

    • id
      Jenis: string

      ID orang Apollo, contohnya daripada carian orang.

    • last_name
      Jenis: string

      Nama akhir, digunakan bersama first_name. Contoh: zheng

    • linkedin_url
      Jenis: string

      URL profil LinkedIn orang itu.

    • name
      Jenis: string

      Nama penuh, contohnya "tim zheng"; menggantikan first_name + last_name.

    • organization_name
      Jenis: string

      Nama majikan orang itu. Contoh: apollo

Respons
  • 200
    Jenis: object

    Respons berjaya

    • credits_consumed
      Jenis: integer

      Medan respons

    • error_code
      Jenis: string

      Medan respons

    • error_message
      Jenis: string

      Medan respons

    • matches
      Jenis: array string[]

      Array respons

    • missing_records
      Jenis: integer

      Medan respons

    • status
      Jenis: string

      Medan respons

    • total_requested_enrichments
      Jenis: integer

      Medan respons

    • unique_enriched_records
      Jenis: integer

      Medan respons

    • waterfall
      Jenis: object

      Objek respons

    application/json
  • 400

    Permintaan tidak dapat diproses. Semak parameter permintaan.

  • 401

    Kunci API Felo yang sah diperlukan.

  • 402

    Permintaan tidak dapat diteruskan kerana keperluan pengebilan tidak dipenuhi.

  • 403

    Akaun tidak dibenarkan melakukan operasi ini.

  • 429

    Had permintaan atau had perbelanjaan telah dicapai.

  • 502

    Perkhidmatan tidak dapat menyelesaikan permintaan.

  • 503

    API atau perkhidmatan pengebilan tidak tersedia buat sementara waktu.

  • 504

    Perkhidmatan tamat masa semasa memproses permintaan.

  • default

    Respons ralat; respons passthrough huluan mungkin menggunakan format penyedia

    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