Sync API
Active integration surface. Pushes descriptions, authorities, and digital objects to a registered external REST target (AtoM today, Archivematica and Albalá planned). Idempotent: payloads short-circuit on hash match. Failed deliveries land in cfg_sync_dead_letter for inspection and retry.
| Method | Path | Summary | Key params | Response |
|---|---|---|---|---|
| POST | /collections/{collection}/libros/{libro}/sync/atom-bulk | Deploy libro to AtoM via CSV + EAC-CPF watch-dir bulk import | collection (path:string)libro (path:integer) | DeployReport |
| POST | /collections/{collection}/libros/{libro}/sync/{target_id} | Sync libro (libro DLU + segments) to external target | collection (path:string)libro (path:integer)target_id (path:string) | SyncReport |
| GET | /collections/{collection}/libros/{libro}/sync/{target_id}/verify | Verify a libro’s AtoM-side deposit state | collection (path:string)libro (path:integer)target_id (path:string) | (no body) |
| GET | /dlus/{id}/sync-status | Get DLU sync state across all targets | id (path:integer) | DluSyncStatusRow[] |
| POST | /dlus/{id}/sync/{target_id} | Sync DLU to external target | id (path:integer)target_id (path:string) | SyncReport |
| GET | /sync/dead-letter | List unacknowledged dead-lettered sync resources | — | DeadLetterRow[] |
| POST | /sync/dead-letter/{letter_id}/acknowledge | Acknowledge a dead-letter row without retrying | letter_id (path:integer)body: AcknowledgeBody | DeadLetterAck |
| POST | /sync/dead-letter/{letter_id}/retry | Re-queue a dead-lettered resource for retry | letter_id (path:integer) | DeadLetterAck |
Examples
Section titled “Examples”Push one DLU to its sync target
curl -X POST -H "X-API-Key: $API_KEY" \ "$ARCHAIC/dlus/{id}/sync/{target_id}"