Point de terminaison de l'API

L’API de stockage expose des points de terminaison accessibles via des requêtes HTTP. Les sections suivantes décrivent les points de terminaison disponibles et leur utilisation.

Méthode : PUT

Pour télécharger ou mettre à jour un fichier dans le système de stockage, vous pouvez utiliser la méthode PUT dans le point de terminaison /studiocms_api/storage/manager.

PUT /studiocms_api/storage/manager HTTP/1.1
Host: example.com
Content-Type: application/octet-stream
Accept: application/json
Headers:
  x-storage-key: my-file.txt

<file-content>

Réponse de succès

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "string",
  "key": "string"
}

Réponse d’erreur

HTTP/1.1 4XX/5XX Error
Content-Type: application/json

{
  "error": "string"
}

Méthode : POST

POST /studiocms_api/storage/manager HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json

{
  "action": "resolveUrl | publicUrl | upload | list | delete | rename | download | cleanup | mappings | test",
  ...paramètres supplémentaires reposant sur l'action...
}

Actions

resolveUrl
- Paramètres : { identifier: string }
- Réponse : UrlMetadata
publicUrl
- Paramètres : { key: string }
- Réponse : UrlMetadata & { identifier: string }
upload
- Paramètres : { key: string, contentType: string }
- Réponse : { url: string, key: string }
list
- Paramètres : { prefix?: string, key?: string }
- Réponse : { files: File[] }
delete
- Paramètres : { key: string }
- Réponse : { success: boolean }
rename
- Paramètres : { key: string, newKey: string }
- Réponse : { success: boolean, newKey: string }
download
- Paramètres : { key: string }
- Réponse : { url: string }
cleanup
- Paramètres : N/A
- Réponse : { deletedCount: number }
mappings
- Paramètres : N/A
- Réponse : { mappings: UrlMetadata[] }
test
- Paramètres : N/A
- Réponse : { success: boolean, message: string, provider: string }

Réponse d’erreur

HTTP/1.1 4XX/5XX Error
Content-Type: application/json

{
  "error": "string"
}

Types

UrlMetadata

export interface UrlMetadata {
    url: string;
    isPermanent: boolean;
    expiresAt?: number; // Horodatage Unix en ms
}

File

export interface File {
    key: string | undefined;
    size: number | undefined;
    lastModified: Date | undefined;
}