Felo API PlatformFelo API Platform
Všechny endpointy Apollo
v0.2.0-beta
OpenAPI 3.1.0

Hromadné obohacení osob

Server:https://openapi.felo.ai
Klientské knihovny

Apollo

​

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

Hromadné obohacení osob

​

Obohacuje osoby uvedené v poli details v těle požadavku. Používejte zdokumentovaná pole detailů a ovládací prvky obohacení tohoto endpointu; neodvozujte vstupní kontrakt endpointu pro jednu osobu z tohoto dávkového požadavku. Vyžaduje administrátorské oprávnění Felo.

Referenční údaje o cenách

  • Měření: měřené jednotky odpovědi.
  • Referenční odhad požadavku: USD 1.7775.
  • Nákladová základna jednotky: USD 0.0.
  • Jednotka prostředků: provider_credit.
  • Referenční multiplikátor pro zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.
  • Nákladové základny neurčují konečnou cenu pro zákazníka, ani když jsou nulové.

Pouze referenční metadata — nejde o nabídku pro účet, garantovanou cenu ani limit útraty. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Parametry dotazu
  • reveal_phone_number
    Typ: boolean
  • run_waterfall_email
    Typ: boolean
  • run_waterfall_phone
    Typ: boolean
  • webhook_url
    Typ: string
    minimální délka:  
    1
    maximální délka:  
    2048
    Formát: https_url
Tělo
povinné
application/json
  • details
    Typ: array object[]
    povinné

    U každé osoby, kterou chcete obohatit, uveďte informace jako objekt v tomto poli. Přidejte maximálně 10 osob.

    Jedna osoba k obohacení. Uveďte všechny identifikátory, které máte — čím více, tím pravděpodobnější shoda.

    • domain
      Typ: string

      Doména zaměstnavatele osoby, bez www. Příklad: apollo.io

    • email
      Typ: string

      E-mailová adresa osoby.

    • first_name
      Typ: string

      Jméno, používá se s last_name. Příklad: tim

    • hashed_email
      Typ: string

      Hash MD5 nebo SHA-256 e-mailové adresy.

    • id
      Typ: string

      ID osoby Apollo, např. z vyhledávání osob.

    • last_name
      Typ: string

      Příjmení, používá se s first_name. Příklad: zheng

    • linkedin_url
      Typ: string

      URL profilu LinkedIn osoby.

    • name
      Typ: string

      Celé jméno, např. "tim zheng"; nahrazuje first_name + last_name.

    • organization_name
      Typ: string

      Název zaměstnavatele osoby. Příklad: apollo

Odpovědi
  • 200
    Typ: object

    Úspěšná odpověď

    • credits_consumed
      Typ: integer

      Pole odpovědi

    • error_code
      Typ: string

      Pole odpovědi

    • error_message
      Typ: string

      Pole odpovědi

    • matches
      Typ: array string[]

      Array odpovědi

    • missing_records
      Typ: integer

      Pole odpovědi

    • status
      Typ: string

      Pole odpovědi

    • total_requested_enrichments
      Typ: integer

      Pole odpovědi

    • unique_enriched_records
      Typ: integer

      Pole odpovědi

    • waterfall
      Typ: object

      Objekt odpovědi

    application/json
  • 400

    Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.

  • 401

    Je vyžadován platný API klíč Felo.

  • 402

    V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.

  • 403

    Účet nemá oprávnění tuto operaci provést.

  • 429

    Byl dosažen limit požadavků nebo útraty.

  • 502

    Služba nemohla požadavek dokončit.

  • 503

    API nebo fakturační služba je dočasně nedostupná.

  • 504

    Při zpracování požadavku vypršel časový limit služby.

  • default

    Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

    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