API Description v1
Fontrocker API Documentation v1
Precondition
To interact with our API service, first grab your personal API key from your backend at https://api.fontrocker.com. This API key needs to be transferred as additional http header for every request as Authorization: Bearer <token>.
Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| font | STRING | ID of the font to use | 5bc2e50ab9f |
| text | STRING | String of the text to print | Call me Superhero |
|
align (optional) |
STRING | Align text, if multiple lines | left (default), center, right |
Getting a preview image
The returned image of the preview service is for usage in your online creator/editor, where your customers can visualize, how their product will look like.
To prevent traffic overflow, and secure your budget, we kindly ask you, to implement a debouncing of minimum 500ms for every refresh request. Contact us, to get technical support.
Endpoint: https://api.fontrocker.com/v1/preview
The output format for the preview image is webp, which can be used directly from inside the browser.
Getting a high resolution image
The returned image can be used for printing on paper, posters, mugs, fabric of any kind (like T-Shirts or Caps). The image creation is asynchronous, which means, that you’ll get back a unique identifier, rather than the image itself.
Endpoint: https://api.fontrocker.com/v1/hires
As a result you will get an HTTP code 201 (created) with a Job-ID
Caution: These images are getting pretty big, pretty soon!
The output format for the preview image png.