Felo API PlatformFelo API Platform
Todos los endpoints de Apollo
v0.2.0-beta
OpenAPI 3.1.0

Enriquecimiento de personas en lote

Servidor:https://openapi.felo.ai
Bibliotecas cliente

Apollo

​

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

Enriquecimiento de personas en lote

​

Enriquece a las personas indicadas en el array details del cuerpo de la solicitud. Usa los campos de detalle y los controles de enriquecimiento documentados de este endpoint; no deduzcas el contrato de entrada del endpoint de una sola persona a partir de esta solicitud en lote. Requiere permiso de administración de Felo.

Pricing reference

  • Medición: unidades de respuesta medidas.
  • Estimación de referencia por solicitud: USD 1.7775.
  • Base de costo unitario: USD 0.0.
  • Unidad de recurso: provider_credit.
  • Multiplicador de referencia del cliente: 1.0. No lo apliques de nuevo a un importe ya liquidado del cliente.
  • Las bases de costo no determinan el precio final del cliente, incluso cuando son cero.

Solo metadatos de referencia; no son una cotización de la cuenta, un precio garantizado ni un límite de gasto. Los créditos de recursos no son créditos de Felo. Los cargos finales se rigen por los registros de facturación de Felo.

Parámetros de consulta
  • reveal_phone_number
    Tipo: boolean
  • run_waterfall_email
    Tipo: boolean
  • run_waterfall_phone
    Tipo: boolean
  • webhook_url
    Tipo: string
    longitud mín.:  
    1
    longitud máx.:  
    2048
    Formato: https_url
Cuerpo
obligatorio
application/json
  • details
    Tipo: array object[]
    obligatorio

    Proporciona la información de cada persona que quieres enriquecer como un objeto dentro de este array. Añade hasta 10 personas.

    Una persona que enriquecer. Proporciona todos los identificadores que tengas: cuantos más, más probable será la coincidencia.

    • domain
      Tipo: string

      Dominio del empleador de la persona, sin www. Ejemplo: apollo.io

    • email
      Tipo: string

      Dirección de correo electrónico de la persona.

    • first_name
      Tipo: string

      Nombre, usado con last_name. Ejemplo: tim

    • hashed_email
      Tipo: string

      Hash MD5 o SHA-256 de la dirección de correo electrónico.

    • id
      Tipo: string

      ID de persona de Apollo, por ejemplo, de una búsqueda de personas.

    • last_name
      Tipo: string

      Apellido, usado con first_name. Ejemplo: zheng

    • linkedin_url
      Tipo: string

      URL del perfil de LinkedIn de la persona.

    • name
      Tipo: string

      Nombre completo, por ejemplo, "tim zheng"; sustituye a first_name + last_name.

    • organization_name
      Tipo: string

      Nombre del empleador de la persona. Ejemplo: apollo

Respuestas
  • 200
    Tipo: object

    Respuesta correcta

    • credits_consumed
      Tipo: integer

      Campo de respuesta

    • error_code
      Tipo: string

      Campo de respuesta

    • error_message
      Tipo: string

      Campo de respuesta

    • matches
      Tipo: array string[]

      Array de respuesta

    • missing_records
      Tipo: integer

      Campo de respuesta

    • status
      Tipo: string

      Campo de respuesta

    • total_requested_enrichments
      Tipo: integer

      Campo de respuesta

    • unique_enriched_records
      Tipo: integer

      Campo de respuesta

    • waterfall
      Tipo: object

      Objeto de respuesta

    application/json
  • 400

    No se pudo procesar la solicitud. Comprueba los parámetros de la solicitud.

  • 401

    Se requiere una clave de API de Felo válida.

  • 402

    La solicitud no puede continuar porque no se cumple un requisito de facturación.

  • 403

    La cuenta no tiene permiso para realizar esta operación.

  • 429

    Se ha alcanzado un límite de solicitudes o de gasto.

  • 502

    El servicio no pudo completar la solicitud.

  • 503

    La API o el servicio de facturación no están disponibles temporalmente.

  • 504

    El servicio agotó el tiempo de espera al procesar la solicitud.

  • default

    Respuesta de error; las respuestas de paso del upstream pueden usar formatos del proveedor

    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