POSThttps://api.veriko.mx/v1/beneficiaries/imports/{id}/commit

Confirmar la importación masiva

Audiencia
public
Autenticación
API key
Permiso
beneficiaries:create
Guía de uso →

Confirma un trabajo de importación y dispara la persistencia de sus filas en GET /v1/beneficiaries.

La operación es asíncrona: el endpoint responde con un estado HTTP 202 y la importación pasa a estado committing mientras el trabajador procesa las filas. Puedes sondear GET /v1/beneficiaries/imports/{id} hasta obtener un estado completed o failed.

Reglas de la confirmación:

  • Filas valid y correctable: Se persisten (con sufijo de alias si hubo colisión de alias).
  • Filas fatal y duplicate_account: Se omiten.
  • Cuentas previamente archivadas con el mismo número: Se reactivan en lugar de duplicarse.
Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
id*pathintegerobligatorio

ID numérico del trabajo de importación.

p. ej. 42
Petición
curl -X POST 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/commit' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 202CommitBeneficiaryImportResponse — Commit encolado al trabajador. La importación pasa a `committing`.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

type*string

Tipo del recurso JSON:API. Siempre beneficiary_import.

p. ej. beneficiary_import
id*string

Identificador numérico del trabajo de importación (expresado como string).

p. ej. 42
attributes*object

Atributos de la importación devueltos tras la confirmación (estado de transición).

status*string

Nuevo estado tras encolar la confirmación. El único valor posible es committing.

p. ej. committing
metaobject

Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f6
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC — la zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601 — sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaPOST /v1/beneficiaries/imports/{id}/commit
CódigoClaseDescripciónCuerpo
2022xxCommit encolado al trabajador. La importación pasa a committing.CommitBeneficiaryImportResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4044xxEl recurso no existe o no es visible para el clienteError
4224xxPre-condición de confirmación no cumplida. Códigos posibles: job_not_committable (estado != preview_ready), plan_cap_exceeded (cuando el cap esté activo) o el genérico commit_failed alternativa.ErrorResponse
Errores de POST /v1/beneficiaries/imports/{id}/commit
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0
422job_not_committable

La confirmación no está permitida en este estado.

Envelope
meta.request_id
a5b6c7d8e9f0