Skip to main content
POST
Przygotuj przesyłanie obrazu referencyjnego JPG, PNG lub WebP o rozmiarze do 8 MiB. Użyj thumbnails_upload_sign_parts, aby uzyskać adresy URL PUT, prześlij dane, a następnie wywołaj thumbnails_upload_complete i użyj jego fileKey podczas generowania.

Uwierzytelnianie i uprawnienia

string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są akceptowane tylko przez MCP, a nie przez ten endpoint REST.
Wymagane uprawnienia: thumbnails:write. Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.

Parametry

string
Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi.Format: “uuid”. Wzorzec: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
wymagane
Nazwa pliku obrazu z rozszerzeniem odpowiadającym contentType.Minimalna długość: 1. Maksymalna długość: 250. Wzorzec: \.(?:jpe?g|png|webp)$.
string
wymagane
Wartość tekstowa.Dozwolone wartości: “image/jpeg”, “image/png”, “image/webp”.
integer
wymagane
Dokładny rozmiar pliku w bajtach, do 8 MiB.Minimum: 1. Maksimum: 8388608.
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.

Idempotencja

Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie. Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny.

Przykłady żądań

Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.

Odpowiedź

Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Nowa sesja wieloczęściowego przesyłania obrazu referencyjnego, przyszły klucz obiektu, rozmiar części w bajtach i maksymalna liczba równoległych przesyłań. Nie przesyła to żadnych bajtów obrazu ani nie przygotowuje key do generowania.

Pola wyniku

Odzyskaj żądanie i sprawdź jego stan

Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp.
HTTP 200

Uwagi do operacji

  • Wymaga thumbnails:write; dodatkowy zakres przesyłania nie jest potrzebny.
  • Z filename usuwane są skrajne białe znaki; musi zawierać 1–250 znaków i kończyć się na .jpg, .jpeg, .png lub .webp. Rozszerzenie musi odpowiadać contentType: image/jpeg, image/png lub image/webp. fileSize to dokładna całkowita liczba bajtów, od 1 do 8,388,608.
  • Wspólna implementacja przesyłania zwraca dla tych plików referencyjnych partSize 5 MiB (5,242,880 bajtów). Plik o rozmiarze do 5 MiB zajmuje jedną część; większy plik o rozmiarze do 8 MiB zajmuje dwie. Pobierz adresy URL dla PUT za pomocą thumbnails_upload_sign_parts, prześlij bajty, a następnie wywołaj thumbnails_upload_complete.
  • Użyj fileKey zwróconego po ukończeniu jako elementu referenceImageKeys w thumbnails_generate. Wynik inicjalizacji używa key, a nie fileKey. Nie przekazuj key do generowania przed ukończeniem przesyłania.
  • Produkcyjna sesja przesyłania wygasa po 24 godzinach. Podpisane adresy URL części wygasają po jednej godzinie. Zakończenie i przerwanie przesyłania usuwa aktywną sesję; sign-parts i complete zwracają wtedy Upload not found. Żadna z tych odpowiedzi nie zawiera pola expiresAt.
  • Ta akcja korzysta z własnych utworzonych materiałów i przesłanych plików połączonego użytkownika, również gdy dane uwierzytelniające są połączone w kontekście zespołu.
  • Użyj requestId w formacie UUID v4 lub nagłówka HTTP Idempotency-Key i używaj tej samej wartości z identycznymi danymi wejściowymi przy ponownych próbach. Warstwa integracji zapisuje każdą modyfikację i zwraca jej zapisany stan lub wynik bez ponownego wykonywania. Żądanie w stanie failed lub interrupted nie jest automatycznie ponawiane.
  • Nazwa pliku w kluczu obiektu jest oczyszczana i może zostać skrócona. Zachowaj dokładnie zwrócone key i uploadId; nie twórz ich samodzielnie. Bajty obrazu są weryfikowane podczas generowania, a zadeklarowany rozmiar i typ — podczas przesyłania.

Wykorzystanie

Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.

Błędy