Endpoint de API

La API de almacenamiento expone endpoints a los que se puede acceder mediante solicitudes HTTP. Las siguientes secciones describen los endpoints disponibles y su uso.

Método: PUT

Para subir o actualizar un archivo en el sistema de almacenamiento, puedes usar el método PUT en el endpoint /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

<contenido-del-archivo>

Respuesta exitosa

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

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

Respuesta de error

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

{
  "error": "string"
}

Método: 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",
  ...parámetros adicionales según la acción...
}

Acciones

resolveUrl
- Parámetros: { identifier: string }
- Respuesta: UrlMetadata
publicUrl
- Parámetros: { key: string }
- Respuesta: UrlMetadata & { identifier: string }
upload
- Parámetros: { key: string, contentType: string }
- Respuesta: { url: string, key: string }
list
- Parámetros: { prefix?: string, key?: string }
- Respuesta: { files: File[] }
delete
- Parámetros: { key: string }
- Respuesta: { success: boolean }
rename
- Parámetros: { key: string, newKey: string }
- Respuesta: { success: boolean, newKey: string }
download
- Parámetros: { key: string }
- Respuesta: { url: string }
cleanup
- Parámetros: N/A
- Respuesta: { deletedCount: number }
mappings
- Parámetros: N/A
- Respuesta: { mappings: UrlMetadata[] }
test
- Parámetros: N/A
- Respuesta: { success: boolean, message: string, provider: string }

Respuesta de error

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

{
  "error": "string"
}

Tipos

UrlMetadata

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

Archivo

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