Contactos
Buscar contactos por referencia externa
A partir de una lista de tus referencias, indica cuáles ya existen en Filmo y cuáles no.
Ejemplos de petición
curl https://app.filmo.io/api/v1/contacts/lookup \
--request POST \
--header "Authorization: Bearer $FILMO_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"references": [
"ERP-CLI-0042",
"ERP-CLI-0043",
"ERP-CLI-9999"
]
}'Generado a partir del esquema
notFound son las que hay que crear. Es la primitiva de cualquier sincronización: sin ella, la alternativa es una llamada por referencia y deducirlo del 404. NO escribe NADA, aunque sea un POST: la lista de referencias no cabe en una query string.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. contacts:read
Cuerpo
Esquema del cuerpo: ContactsLookupBody
Referencias externas que buscar. Al menos una, como máximo 200.
Límites: mín. 1 elementos, máx. 200 elementos, cada uno: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: ContactsLookupResultDto
Sobre: ContactsLookupResultResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Resultado de buscar contactos por referencia externa.
Mostrar atributos hijosOcultar atributos hijos
Contactos que coincidieron con al menos una referencia.
Mostrar atributos hijosOcultar atributos hijos
Identificador del contacto en Filmo.
Nombre del contacto.
Número del contacto en Filmo.
Referencias que no coincidieron con ningún contacto. Son las que hay que crear.
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Conflicto (conflict): el estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, o otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
| 409 | conflict | El estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Relacionado
¿Te ha resultado útil esta página?