The Web API Client is a browser application for trying out the ZSK Web API interactively. It builds the requests described in this documentation from a form, sends them to the ZSK Web API and shows the results. Use it to try out texts, fonts and parameters before you integrate the API into your own application.
Open the Web API Client: https://tools.embroidery-api.com/WebAPI.html
What you can do
- Enter up to 9 monogram text lines, each with its own font, size, needle, stitch parameter, alignment, stitching sequence, bend, character spacing, pull compensation and kerning. The fonts and stitch parameters are loaded from the server with GetFontList and GetFontSettings.
- Define up to 24 needle colors, or pick them from a real thread range (Thread cones).
- Combine the texts with an existing embroidery design (TBF, TC/Z00, DST, DSZ) and place them around it; see TextAlignment to Design. Optionally add a needle assignment file or read the design's needle colors with GetNeedleInfo.
- Show a TrueView preview (CreatePNG) and save it, or create and save the embroidery file as TC, TBF, DST or DSZ.
- Show the request JSON ({ } button), edit it, and save it as a .json file to use as a template for your own requests.
- Change the service URL, the TrueView rendering settings, the PNG resolution and the
ServerVersionin the settings (⚙ button).
Requirements
- A ZSK Web API license key. Enter it in the License key (WebApiLicense) field. The key is stored in your browser, so you only enter it once.
- A current web browser. The texts and embroidery files are sent to the ZSK Web API server for processing.
Good to know
- Every section has a help button (?) that explains its fields and the request parameters they are sent as.