EWA API technical notes

EWA API technical notes

Wilcomโ€™s Embroidery Web API is a cloud-hosted, RESTful interface that enables developers to integrate professional embroidery design and personalization features into websites, e-commerce platforms, or internal systems. The API supports rendering, editing, auto-digitizing, and file conversion of embroidery designs using XML-based communication.

๐Ÿ”ง Technical features

FeatureNotes
API typeRESTful with XML request/response
AuthenticationApp ID + App Key
HostingAWS-backed global servers
Supported formatsEMB, DST, PES, EXP, PDF, PNG, JPG, etc
Embroidery fontsOver 200 Wilcom embroidery fonts โ€” custom ESA fonts supported

๐Ÿ” Authentication

  • App ID and App Key are required for all API requests.
  • Credentials are issued upon subscription via Wilcomโ€™s Developer Portal.
  • Authentication is passed via HTTP headers:
    -H "Authorization: AppKey YOUR_APP_KEY"

๐Ÿ“ฆ Data format

Data
Format
Request/response format
XML
Root element
<xml>
Input/output
All payloads use structured XML with specific schema per endpoint.
File contents
File contents are embedded in <files> elements (Base64 encoded).

๐Ÿ“ Key file types

File type
Usage
Format examples
Embroidery design
Input/Output
EMB, DST, EXP, PES, JEF, etc
Artwork (vector/bitmap)
Input for previews/digitizing
PDF, EPS, PNG, JPG, PSD, etc
Preview image
Output only
PNG with transparent background

โš™๏ธ Core API endpoints

Endpoint
Description
api/designInfo
Returns metadata about existing EMB file โ€” stitch count, size, colors, etc.
api/designTrueview
Returns TrueView images for all colorways.
api/newDesign
Generates complete embroidery design from components ('recipe').
api/newDesignTrueview
Generates TrueView of new design.
api/newLetteringPreview
Fast preview of single lettering (basic performance).
api/editDesign, api/editDesignTrueview
Edit text, font, color in existing EMB designs.
api/info
Returns API version and list of available fonts.
api/bitmapArtPreview, api/vectorArtPreview
Previews bitmap/vector logos with transparent background.
api/bitmapArtDesign, api/vectorArtDesign
Auto-digitizes artwork into production-ready embroidery.
api/bitmapArtTrueview, api/vectorArtTrueview
Renders TrueView of digitized artwork.

๐Ÿงช Sample API request

  -H "Authorization: AppKey YOUR_APP_KEY" \
  -d '<xml><design><filename>sample.emb</filename></design></xml>'

๐Ÿ“„ Recipe-based architecture

  1. Most API calls rely on a 'recipe' which defines:
    1. Text, font, color, positioning, monograms, team names
    2. Transformations โ€” scale, rotation, mirror
    3. Combination of components โ€” e.g. base design + lettering
  2. Recipes are embedded within the <xml> payloads.

๐Ÿ–ผ๏ธ TrueViewโ„ข images

  • PNG output with 96 DPI, scaled 1:1
  • Transparent background
  • Auto-compressed if over 4MB โ€” resolution will be halved until it fits.

๐Ÿ“ Artwork limitations

The API only accepts requests smaller than 20MB. Large artwork files take too long to process and use too many server resources. To avoid this, EWA has set the following restrictions:

Limitation

Value

Note

Maximum file size

2MB

 

Maximum pixel count

5,000,000 pixels

For vector file, EWA calculates pixel count in 300DPI.

Maximum area size

22,500 square millimetres

 

Maximum processing time

90 seconds

 

๐Ÿ› ๏ธ Error handling

The API returns standard HTTP status codes:
  1. 200 OK โ€“ Success
  2. 400 Bad Request โ€“ Invalid input
  3. 500 Internal Server Error โ€“ Server-side issue
Error details are returned in an <error_info> XML block:
<error_info>
  <code>400</code>
  <message>Invalid EMB filename</message>
</error_info>

    • Related Articles

    • EWA API overview

      Wilcom’s Embroidery Web API (EWA) is a modern, third-generation web-based software toolkit designed specifically for web developers in the embroidery and apparel industries. It allows businesses to seamlessly integrate professional embroidery ...

    • EWA API getting started

      These notes guide developers through the initial setup, authentication, API calling structure, and development tools available for integrating the Wilcom Embroidery Web API into web applications. ✅ Step 1: Sign up and get API credentials Visit the ...

    • EWA API capabilities

      Wilcom’s Embroidery Web API (EWA) provides a RESTful interface for integrating advanced embroidery capabilities into web and cloud-based applications. The API exposes functionality for rendering, modifying, and generating embroidery designs using ...

    • Wilcom Technical Support Policy

      Wilcom Technical Support Policies Overview Wilcom are committed to ensuring that our customers get the most from their Wilcom software. For this reason, we offer a comprehensive range of support and training offerings, in many cases including free ...

    • EWA API business case

      In today’s fast-paced, personalization-driven market, embroidery businesses and e-commerce platforms must offer instant customization, real-time previews, and automated production workflows. The Wilcom Embroidery Web API (EWA) is a robust, ...