Felo API PlatformFelo API Platform
Wszystkie endpointy Apollo
v0.2.0-beta
OpenAPI 3.1.0

Masowe wzbogacanie osób

Serwer:https://openapi.felo.ai
Biblioteki klienckie

Apollo

​

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

Masowe wzbogacanie osób

​

Wzbogaca osoby wymienione w tablicy details w treści żądania. Korzystaj z udokumentowanych pól szczegółów i opcji wzbogacania tego endpointu; nie wywnioskowuj kontraktu wejściowego endpointu dla jednej osoby z tego żądania wsadowego. Wymaga uprawnień administracyjnych Felo.

Informacje referencyjne o rozliczaniu

  • Rozliczanie: rozliczane jednostki odpowiedzi.
  • Referencyjny szacunek żądania: USD 1.7775.
  • Podstawa kosztu jednostkowego: USD 0.0.
  • Jednostka zasobów: provider_credit.
  • Referencyjny mnożnik klienta: 1.0. Nie stosuj go ponownie do rozliczonej kwoty klienta.
  • Podstawy kosztu nie określają ostatecznej ceny dla klienta, także gdy wynoszą zero.

Wyłącznie metadane referencyjne — nie stanowią oferty dla konta, gwarantowanej ceny ani limitu wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Parametry zapytania
  • reveal_phone_number
    Typ: boolean
  • run_waterfall_email
    Typ: boolean
  • run_waterfall_phone
    Typ: boolean
  • webhook_url
    Typ: string
    min. długość:  
    1
    maks. długość:  
    2048
    Format: https_url
Treść
wymagane
application/json
  • details
    Typ: array object[]
    wymagane

    Podaj informacje o każdej osobie do wzbogacenia jako obiekt w tej tablicy. Dodaj maksymalnie 10 osób.

    Jedna osoba do wzbogacenia. Podaj dowolne dostępne identyfikatory — im więcej, tym większa szansa na dopasowanie.

    • domain
      Typ: string

      Domena pracodawcy osoby, bez www. Przykład: apollo.io

    • email
      Typ: string

      Adres e-mail osoby.

    • first_name
      Typ: string

      Imię, używane razem z last_name. Przykład: tim

    • hashed_email
      Typ: string

      Skrót MD5 lub SHA-256 adresu e-mail.

    • id
      Typ: string

      Identyfikator osoby Apollo, np. z wyszukiwania osób.

    • last_name
      Typ: string

      Nazwisko, używane razem z first_name. Przykład: zheng

    • linkedin_url
      Typ: string

      URL profilu LinkedIn osoby.

    • name
      Typ: string

      Pełne imię i nazwisko, np. "tim zheng"; zastępuje first_name + last_name.

    • organization_name
      Typ: string

      Nazwa pracodawcy osoby. Przykład: apollo

Odpowiedzi
  • 200
    Typ: object

    Pomyślna odpowiedź

    • credits_consumed
      Typ: integer

      Pole odpowiedzi

    • error_code
      Typ: string

      Pole odpowiedzi

    • error_message
      Typ: string

      Pole odpowiedzi

    • matches
      Typ: array string[]

      Tablica odpowiedzi

    • missing_records
      Typ: integer

      Pole odpowiedzi

    • status
      Typ: string

      Pole odpowiedzi

    • total_requested_enrichments
      Typ: integer

      Pole odpowiedzi

    • unique_enriched_records
      Typ: integer

      Pole odpowiedzi

    • waterfall
      Typ: object

      Obiekt odpowiedzi

    application/json
  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Odpowiedź błędu; odpowiedzi przekazywane bezpośrednio od dostawcy upstream mogą używać formatów dostawcy

    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