Publiczne API creativehub pozwala Twojemu oprogramowaniu wgrywać grafiki, budować i publikować dropy oraz składać zamówienia. Żądania trafiają na https://escher-v2.creativehub.io/v1 z tokenem okaziciela esch_live_ — aby go uzyskać, zobacz Jak utworzyć tokeny API dla publicznej powierzchni /v1.
Dokumentacja
Dokumentacja API jest publiczna pod adresem https://sell.creativehub.io/api-docs (https://api.creativehub.io również tam przekierowuje). Pełna powierzchnia /v1 jest też opisana w endpoincie OpenAPI (/openapi.json w usłudze API).
Grupy endpointów
- Uploads —
POST /v1/uploads(plik),POST /v1/uploads/ref(obraz przez URL), sesje wgrywania (POST /v1/uploads/sessions,…/sessions/complete),POST /v1/uploads/link(tymczasowy link, pod którym ktoś upuszcza pliki w przeglądarce),GET /v1/uploads,GET /v1/uploads/{id}. - Drops —
POST /v1/drops,GET /v1/drops,GET/PATCH/DELETE /v1/drops/{drop_id},POST /v1/drops/{drop_id}/assets(logo, podpis, list). - Products —
POST /v1/drops/{drop_id}/products,PUT /v1/drops/{drop_id}/products/{product_id}/variants,DELETE …/products/{product_id};GET /v1/products,GET /v1/products/{id},GET /v1/products/{id}/variants. - Recommendations —
POST /v1/recommendations(drop),POST /v1/drops/{drop_id}/products/{product_id}/recommendations(jedna grafika). - Page styles —
GET /v1/styles/schema,GET /v1/styles,POST /v1/styles/extract(zwraca pięć wariantów do wyboru),GET /v1/styles/variations/{id},POST /v1/styles,GET/PATCH/DELETE /v1/styles/{style_id},POST /v1/drops/{drop_id}/style-preview(15-minutowy link podglądu). - Publishing —
POST /v1/drops/{drop_id}/publish,GET /v1/drops/{drop_id}/publish-attempts/latest. - Orders and invoices —
POST /v1/orders/quote,POST /v1/orders,GET /v1/orders,GET /v1/orders/{id},GET /v1/invoices,GET /v1/invoices/{id}.
Wgrywanie plików
Możesz wgrywać pliki bezpośrednio. POST /v1/uploads przyjmuje bajty pliku jako treść żądania: treścią jest surowy plik, a nie formularz multipart. Akceptuje JPEG, PNG lub TIFF do 2 GB i wymaga nagłówka Content-Length; formularz multipart jest odrzucany z kodem HTTP 415.
Jeśli obraz jest już hostowany, zarejestruj go przez jego publiczny URL za pomocą POST /v1/uploads/ref. Sesje wgrywania (/v1/uploads/sessions) i linki do wgrywania (/v1/uploads/link) to dwie pozostałe drogi.
Sprawdzaj obrazy samodzielnie
Nie ma endpointu preflight dla dpi, wymiarów, proporcji ani profilu kolorów. Zweryfikuj każdy obraz we własnym backendzie przed zamówieniem i przygotuj go dokładnie w obszarze obrazu, który chcesz wydrukować.
Jak wygląda plik gotowy do druku, pokazuje poradnik Jak sfotografować lub zeskanować pracę: zawiera cztery testy, które sprawdzają, czy plik jest wystarczająco dobry.
Obramowania wariantów
Obramowania ustawiane przez API to tylko presety: none, small lub large. Nie możesz ustawić obramowania osobno dla każdej strony.
Zanim zautomatyzujesz premierę, dobrze jest zobaczyć ją oczami kupującego: strona Print Drops pokazuje, jak wygląda i przebiega sprzedaż ograniczona czasowo.