#HTTP API

Przesyłanie plików zarówno dla pól załączników, jak i dla kolekcji plików jest obsługiwane przez HTTP API. Sposób wywołania różni się w zależności od silnika przechowywania używanego przez pole załącznika lub kolekcję plików.

#Przesyłanie po stronie serwera

W przypadku wbudowanych, otwartych silników przechowywania, takich jak S3, OSS i COS, wywołanie HTTP API jest takie samo jak funkcja przesyłania plików z interfejsu użytkownika, a pliki są przesyłane po stronie serwera. Wywołanie API wymaga przekazania tokenu JWT (opartego na logowaniu użytkownika) w nagłówku żądania Authorization; w przeciwnym razie dostęp zostanie odrzucony.

#Pole załącznika

Proszę zainicjować akcję create na zasobie attachments (tabela załączników), wysłać żądanie POST i przesłać zawartość binarną za pośrednictwem pola file. Po wywołaniu plik zostanie przesłany do domyślnego silnika przechowywania.

curl -X POST \
    -H "Authorization: Bearer <JWT>" \
    -F "file=@<path/to/file>" \
    "http://localhost:3000/api/attachments:create"

Aby przesłać plik do innego silnika przechowywania, mogą Państwo użyć parametru attachmentField, aby określić silnik przechowywania skonfigurowany dla pola kolekcji (jeśli nie jest skonfigurowany, zostanie przesłany do domyślnego silnika przechowywania).

curl -X POST \
    -H "Authorization: Bearer <JWT>" \
    -F "file=@<path/to/file>" \
    "http://localhost:3000/api/attachments:create?attachmentField=<collection_name>.<field_name>"

#Kolekcja plików

Przesyłanie do kolekcji plików automatycznie wygeneruje rekord pliku. Proszę zainicjować akcję create na zasobie kolekcji plików, wysłać żądanie POST i przesłać zawartość binarną za pośrednictwem pola file.

curl -X POST \
    -H "Authorization: Bearer <JWT>" \
    -F "file=@<path/to/file>" \
    "http://localhost:3000/api/<file_collection_name>:create"

Podczas przesyłania do kolekcji plików nie ma potrzeby określania silnika przechowywania; plik zostanie przesłany do silnika przechowywania skonfigurowanego dla tej kolekcji.

#Przesyłanie po stronie klienta

W przypadku silników przechowywania kompatybilnych z S3, dostarczanych przez komercyjną wtyczkę S3-Pro, przesyłanie plików za pomocą HTTP API wymaga kilku kroków.

#Pole załącznika

1. Pobieranie informacji o silniku przechowywania

   Proszę zainicjować akcję getBasicInfo na kolekcji storages (kolekcja silników przechowywania), przekazując nazwę przechowywania, aby uzyskać informacje konfiguracyjne silnika przechowywania.

   curl 'http://localhost:13000/api/storages:getBasicInfo/<storage_name>' \
     -H 'Authorization: Bearer <JWT>'

   Przykład zwróconych informacji konfiguracyjnych silnika przechowywania:

   {
     "id": 2,
     "title": "xxx",
     "name": "xxx",
     "type": "s3-compatible",
     "rules": { ... }
   }

2. Pobieranie wstępnie podpisanych informacji od dostawcy usługi

   Proszę zainicjować akcję createPresignedUrl na zasobie fileStorageS3, wysłać żądanie POST i dołączyć informacje dotyczące pliku w treści żądania, aby uzyskać wstępnie podpisane informacje o przesyłaniu.

   curl 'http://localhost:13000/api/fileStorageS3:createPresignedUrl' \
     -X POST \
     -H 'Accept: application/json, text/plain, */*' \
     -H 'Authorization: Bearer <JWT>' \
     -H 'Content-Type: application/json' \
     --data-raw '{"name":<name>,"size":<size>,"type":<type>,"storageId":<storageId>,"storageType":<storageType>}'

   Uwaga:

   • name: Nazwa pliku
   • size: Rozmiar pliku (w bajtach)
   • type: Typ MIME pliku. Mogą Państwo zapoznać się z: Typowe typy MIME
   • storageId: ID silnika przechowywania (pole id zwrócone w pierwszym kroku)
   • storageType: Typ silnika przechowywania (pole type zwrócone w pierwszym kroku)

   Przykład danych żądania:

   --data-raw '{"name":"a.png","size":4405,"type":"image/png","storageId":2,"storageType":"s3-compatible"}'

   Struktura danych uzyskanych wstępnie podpisanych informacji jest następująca:

   {
     "putUrl": "https://xxxxxxx",
     "fileInfo": {
       "key": "xxx",
       "title": "xxx",
       "filename": "xxx",
       "extname": ".png",
       "size": 4405,
       "mimetype": "image/png",
       "meta": {},
       "url": ""
     }
   }

3. Przesyłanie pliku

   Proszę użyć zwróconego putUrl, aby zainicjować żądanie PUT i przesłać plik jako treść żądania.

   curl '<putUrl>' \
     -X 'PUT' \
     -T <file_path>

   Uwaga:

   • putUrl: Pole putUrl zwrócone w poprzednim kroku
   • file_path: Lokalna ścieżka pliku do przesłania

   Przykład danych żądania:

   curl 'https://xxxxxxx' \
    -X 'PUT' \
    -T /Users/Downloads/a.png

4. Tworzenie rekordu pliku

   Po pomyślnym przesłaniu, proszę zainicjować akcję create na zasobie attachments (tabela załączników), wysyłając żądanie POST, aby utworzyć rekord pliku.

   curl 'http://localhost:13000/api/attachments:create?attachmentField=<collection_name>.<field_name>' \
     -X POST \
     -H 'Accept: application/json, text/plain, */*' \
     -H 'Authorization: Bearer <JWT>' \
     -H 'Content-Type: application/json' \
     --data-raw '{"title":<title>,"filename":<filename>,"extname":<extname>,"path":"","size":<size>,"url":"","mimetype":<mimetype>,"meta":<meta>,"storageId":<storageId>}'

   Opis danych zależnych w data-raw:

   • title: Pole fileInfo.title zwrócone w poprzednim kroku
   • filename: Pole fileInfo.key zwrócone w poprzednim kroku
   • extname: Pole fileInfo.extname zwrócone w poprzednim kroku
   • path: Domyślnie puste
   • size: Pole fileInfo.size zwrócone w poprzednim kroku
   • url: Domyślnie puste
   • mimetype: Pole fileInfo.mimetype zwrócone w poprzednim kroku
   • meta: Pole fileInfo.meta zwrócone w poprzednim kroku
   • storageId: Pole id zwrócone w pierwszym kroku

   Przykład danych żądania:

     --data-raw '{"title":"ATT00001","filename":"ATT00001-8nuuxkuz4jn.png","extname":".png","path":"","size":4405,"url":"","mimetype":"image/png","meta":{},"storageId":2}'

#Kolekcja plików

Pierwsze trzy kroki są takie same jak w przypadku przesyłania plików dla pola załącznika, ale w czwartym kroku należy utworzyć rekord pliku, inicjując akcję create na zasobie kolekcji plików, wysyłając żądanie POST i przesyłając informacje o pliku w treści żądania.

curl 'http://localhost:13000/api/<file_collection_name>:create' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"title":<title>,"filename":<filename>,"extname":<extname>,"path":"","size":<size>,"url":"","mimetype":<mimetype>,"meta":<meta>,"storageId":<storageId>}'

Opis danych zależnych w data-raw:

• title: Pole fileInfo.title zwrócone w poprzednim kroku
• filename: Pole fileInfo.key zwrócone w poprzednim kroku
• extname: Pole fileInfo.extname zwrócone w poprzednim kroku
• path: Domyślnie puste
• size: Pole fileInfo.size zwrócone w poprzednim kroku
• url: Domyślnie puste
• mimetype: Pole fileInfo.mimetype zwrócone w poprzednim kroku
• meta: Pole fileInfo.meta zwrócone w poprzednim kroku
• storageId: Pole id zwrócone w pierwszym kroku

Przykład danych żądania:

  --data-raw '{"title":"ATT00001","filename":"ATT00001-8nuuxkuz4jn.png","extname":".png","path":"","size":4405,"url":"","mimetype":"image/png","meta":{},"storageId":2}'