API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.
styles, frameOptions i logoOptions. Nigdy nie zawiera treści ani linku. Szablony są wspólne dla wszystkich w obszarze roboczym.
Stosowanie szablonu
PrzekażtemplateId, gdy tworzysz kod QR. Projekt szablonu zostanie zastosowany do nowego kodu QR. Każdy z trzech obiektów projektu wysłany w tym samym żądaniu jest z nim scalany i ma przed nim pierwszeństwo.
- Kopia, a nie powiązanie. Kod QR przechowuje własną kopię projektu. Późniejsza edycja lub usunięcie szablonu go nie zmienia.
- Tylko projekty Custom. Szablonu z
designKindrównymbrandedlubainie można zastosować przez API: zwraca422(art_template_unsupported). - Tylko Twój obszar roboczy. Nieznany szablon lub szablon z innego obszaru roboczego zwraca
404.
Nagłówki
string
wymagane
Bearer, a po nim Twój klucz API. Zobacz Uwierzytelnianie.string
application/json. Wymagany w żądaniach z treścią.Obiekt szablonu
string
ID szablonu, np.
qrt_8Hs2mQvKpLd4RtYw.string
Nazwa wyświetlana przy wyborze szablonu.
string
Tylko do odczytu.
custom to projekt, który API może w pełni edytować. branded i ai to projekt Branded lub AI utworzony w panelu: jego grafiki nie można edytować przez API i jest ona zachowywana, gdy zmieniasz pozostałe pola projektu.object
Zapisany projekt. Każde pole ma ten sam kształt co pole żądania o tej samej nazwie, więc możesz je odesłać.
string
Data utworzenia, ISO 8601.
string
Data ostatniej aktualizacji, ISO 8601.
Lista szablonów
GET /api/v1/templates
Zwraca szablony Twojego obszaru roboczego, od najnowszych. Lista jest paginowana: zobacz Paginacja.
integer
domyślnie:"1"
Strona do zwrócenia, 1 lub więcej.
integer
domyślnie:"100"
Liczba wyników na stronę, od 1 do 100.
Tworzenie szablonu
POST /api/v1/templates
Zapisuje nowy projekt. Odpowiada 201 Created. Pola projektu są sprawdzane względem katalogów z przewodnika Personalizacja, więc nieznany kształt, ramka lub logo są odrzucane z kodem 422.
string
wymagane
Nazwa wyświetlana przy wyborze szablonu, od 1 do 40 znaków.
object
Kształty i kolory kropek oraz narożników. Zobacz Personalizacja.
object
Ramka wokół kodu QR i jej tekst wezwania do działania. Zobacz Personalizacja.
object
Logo umieszczone na środku: sugerowane logo albo własny plik przesłany z celem
logo przez Pliki. Zobacz Personalizacja.Odczyt szablonu
GET /api/v1/templates/{templateId}
string
wymagane
ID szablonu. Weź je z odpowiedzi listy lub tworzenia.
Aktualizacja szablonu
PATCH /api/v1/templates/{templateId}
Wysyłaj tylko pola, które chcesz zmienić. Obiekty projektu są scalane z zapisanym projektem, więc częściowe styles zachowuje resztę. Kody QR już utworzone z szablonu zachowują projekt, z którym powstały.
string
wymagane
ID szablonu.
string
Nowa nazwa, od 1 do 40 znaków.
object
Zmiany stylu, scalane z zapisanymi
styles.object
Zmiany ramki, scalane z zapisaną ramką.
object
Zmiany logo, scalane z zapisanym logo.
Usuwanie szablonu
DELETE /api/v1/templates/{templateId}
Usuwa szablon. Kody QR utworzone z niego zachowują swój projekt.
string
wymagane
ID szablonu.
Duplikowanie szablonu
POST /api/v1/templates/{templateId}/duplicate
Tworzy kopię o nazwie <name> copy, z własnym ID i niezależnym projektem, który możesz dowolnie edytować. Nie przyjmuje treści żądania. Odpowiada 201 Created.
string
wymagane
ID szablonu do skopiowania.
Typowe problemy
404 "QR template not found."
404 "QR template not found."
templateId nie odpowiada żadnemu szablonowi w Twoim obszarze roboczym. Weź je z listy szablonów.422 przy tworzeniu lub aktualizacji szablonu
422 przy tworzeniu lub aktualizacji szablonu
Pole projektu nie pasuje do katalogów, np. nieznany typ kropek, ramka lub sugerowane logo. Komunikat wskazuje pole. Zobacz Personalizacja.
422 art_template_unsupported przy tworzeniu kodu QR
422 art_template_unsupported przy tworzeniu kodu QR
Szablon używa projektu Branded lub AI. Zastosuj zamiast niego szablon z
designKind równym custom.