Référence des endpoints
Les 18 opérations, leurs permissions et leurs formats de réponse.
Cette page récapitule les 18 opérations. Tous les chemins du tableau sont à préfixer par /api/ccfn/v1. Les appels nécessitent une souscription active et HTTP Basic. Les refus 401 et 403 sont communs aux opérations, même lorsqu’ils ne figurent pas dans la colonne des résultats spécifiques.
CCFN_USER donne les droits d’usage sur les objets sans donner l’administration des espaces. Les administrateurs restent exclus des objets. Les UUID de chemin doivent être syntaxiquement valides.
Opérations
| Méthode | Chemin | Rôle spécialisé | Format de succès | Codes spécifiques usuels |
|---|---|---|---|---|
GET | /health | Tout rôle CCFN | JSON : état et contrôles | 200, 503 |
GET | /space | CCFN_ADMIN | JSON : espaces paginés | 200, 422 |
POST | /space | CCFN_ADMIN | JSON : nouvel espace | 201, 422 |
GET | /space/{space} | CCFN_ADMIN | JSON : détail espace | 200, 404 |
PATCH | /space/{space} | CCFN_ADMIN | JSON : espace modifié | 200, 404, 422 |
DELETE | /space/{space} | CCFN_ADMIN | JSON : identifiant | 200, 404, 409 |
GET | /object | CCFN_USER_LIST | JSON : objets paginés | 200, 422 |
GET | /object/count | CCFN_USER_COUNT | JSON : data.count | 200, 422 |
POST | /object | CCFN_USER_DEPOSIT | JSON : objet ou état idempotent | 200, 201, 202, 409, 410, 422, 500, 502, 503 |
GET | /object/deposit/status | CCFN_USER_DEPOSIT | JSON : état durable | 200, 202, 404, 422 |
GET | /object/{object} | CCFN_USER_READ | Fichier binaire | 200, 404, 500 |
GET | /object/{object}/metadata | CCFN_USER_METADATA_READ | JSON : métadonnées objet | 200, 404 |
GET | /object/{object}/base64 | CCFN_USER_READ | JSON : fichier Base64 | 200, 404, 413, 500 |
GET | /object/{object}/certificate | CCFN_USER_READ | JSON : certificat PDF Base64 | 200, 404, 500 |
GET | /object/{object}/package | CCFN_USER_READ | Fichier ZIP | 200, 404, 500 |
GET | /object/{object}/integrity | CCFN_USER_CONTROL | JSON : résultat du contrôle | 200, 404, 409, 503 |
PATCH | /object/{object} | CCFN_USER_RETENTION_EXTEND | JSON : rétention prolongée | 200, 404, 422 |
DELETE | /object/{object} | CCFN_USER_DESTROY | JSON : identifiant | 200, 404, 423, 500 |
Champs retournés pour un objet
| Groupe | Champs principaux |
|---|---|
| Identité | id, external_id, company_id, user_id, space_id |
| Document | original_filename, media_type, size_bytes |
| Empreinte | digest_algorithm, digest |
| Métadonnées | metadata, search_attributes, metadata_digest_algorithm, metadata_digest |
| Cycle de vie | deposit_mode, deposited_at, retention_until, encrypted |
| Validation d’entrée | signature_validation_mode, signature_validation_provider, signature_validation_status, signature_validation_policy, et résultat si demandé |
| Preuves | Objet proof avec prestataires, références de transactions, format, niveau, validation du cachet et dates |
encrypted indique l’affectation d’une clé de chiffrement à l’objet. signature_validation_result est présent lorsque la validation d’entrée a été demandée. Les dates et les identifiants de transactions peuvent être nuls lorsque la source ne les fournit pas ; ne les inventez pas côté intégration.
Champs retournés pour un espace
id, external_id, company_id, label, is_active, is_encrypted, lifecycle_duration, signature_validation_policy, created_at et updated_at décrivent l’espace.
La liste des espaces accepte external_id, is_active, page et per_page. Dans une query string, utilisez is_active=1 ou is_active=0 pour éviter une représentation textuelle ambiguë du booléen.
Corps de création et de modification
Les contrats détaillés sont décrits dans Dépôt et Espaces. Le PATCH d’objet ne sert qu’à prolonger sa rétention avec retention_days ; il ne modifie pas le fichier et ses métadonnées métier. L’endpoint de statut reçoit la clé par en-tête, pas par paramètre de chemin.
Opérations non exposées
Cette version ne fournit pas d’endpoint CCFN pour la lecture du journal, l’administration des utilisateurs, le remplacement du contenu, un envoi multipart ou par fragments, la récupération dédiée des binaires de preuve, le gel juridique ou l’exécution à distance des commandes d’exploitation.
Les refus d’accès 401 et 403 restent applicables au ZIP, comme aux autres opérations.
Updated about 2 hours ago