API-referens · v1JSON + multipart

Bygg in broderi i din produkt.

Ett praktiskt REST-API för privat bilddigitalisering och riktig maskinfilkonvertering. Denna sida är den kompletta snabbstarten, slutpunktsreferensen och felguiden.

Skaffa en API-nyckel OpenAPI 3.1

Bas-URL

https://embroideryfileconverter.com/api/developer/v1

Autentisering

Bearer-nyckel

Gräns

60/min

Jobb

Asynkron

Nycklar är avgränsade, upphör, kan återkallas omedelbart och visas endast en gång. Behåll dem på din server – skicka aldrig en i webbläsar- eller mobilklientkod.

Översikt Snabbstart Autentisering Skapa ett jobb Jobblivscykel Slutpunktsreferens Fel och gränser

Snabbstart

Ditt första jobb i tre steg.

Skapa en nyckel

Välj endast de funktioner din tjänst behöver och lagra hemligheten i en serverbaserad hemlighetshanterare.

Skicka källan

POST multipart formulärdata med arbetsflöde, utdataformat och en privat källfil.

Poll:a jobbet

Använd det returnerade arbetsflödet och jobb-ID:t tills status är slutfört eller misslyckat.

Skapa ett konverteringsjobb · Shell

curl -X POST https://embroideryfileconverter.com/api/developer/v1/jobs \
  -H "Authorization: Bearer $EFC_API_KEY" \
  -H "Accept: application/json" \
  -F "workflow=conversion" \
  -F "format=dst" \
  -F "[email protected]"

Autentisering

Avgränsade Bearer-nycklar.

Skicka nyckeln i Authorization-huvudet vid varje begäran. En nyckel kan endast komma åt sin ägares jobb och endast de funktioner som valdes när den skapades.

formats:read

usage:read

jobs:read

jobs:write

Authorization-huvud

Authorization: Bearer efc_live_...
Accept: application/json

Endast serversida

Bädda inte in en utvecklarnyckel i en webbsida, distribuerad skrivbordsbinär eller mobilapp. Proxya begäranden via din backend.

Behöver du delegerad användaråtkomst?

AI-klienter bör använda MCP med OAuth och PKCE istället för att ta emot en utvecklar-API-nyckel.

POST /jobs

Välj arbetsflödet som matchar källan.

workflow=conversion

Befintlig maskinfil

Ladda upp PES, DST, JEF eller ett annat läsbart broderiformat och välj en annan skrivbar utdata.

Krävs: workflow, format, file
Maximal fil: 50 MB

workflow=digitising

JPG-, PNG-, SVG- eller WebP-grafik

Generera en stygnförhandsvisning från grafik. Färdig bredd och maximalt antal trådfärger krävs.

Ytterligare fält: width_mm, colour_count
Giltiga intervall: 10–300 mm · 1–24 färger
Maximal fil: 20 MB

Enskilda filer och batcher

Använd file för en källa eller files[] för upp till 10 källor. Begränsad gratisbearbetning kan acceptera en fil per begäran. Varje batch använder ett delat arbetsflöde och utdataformat.

202 Accepted

{
  "message": "Processing started.",
  "job": {
    "id": "01JEXAMPLEJOBID000000000",
    "status": "queued",
    "workflow": "conversion"
  },
  "jobs": [
    {
      "id": "01JEXAMPLEJOBID000000000",
      "status": "queued",
      "workflow": "conversion"
    }
  ],
  "freeUsage": {
    "previewRemaining": 2,
    "creditBalance": 0
  }
}

Skapande är asynkront

HTTP 202 betyder att det privata jobbet accepterades, inte att maskinfiler är klara. Spara både job.id och job.workflow; arbetsflödet väljer statusrutten.

queuedVäntar på arbetare

processingMotorn kör

completedInspektera utdata och varningar

failedLäs failureCode och failureReason

Polling och filer

Läs resultatet, inte bara status.

Ett slutfört svar innehåller tolkade mätvärden, varningar, händelser, förhandsvisningsartefakter och utdatafiler. Signerade URL:er är kortlivade; begär jobbet igen när en URL upphör.

Hämta ett bearbetningsjobb · Shell

curl https://embroideryfileconverter.com/api/developer/v1/jobs/conversion/01JEXAMPLEJOBID000000000 \
  -H "Authorization: Bearer $EFC_API_KEY" \
  -H "Accept: application/json"

Mätvärden

Stygnantal, mått och motorspecifika mätningar.

Varningar

Kompatibilitets- eller produktionsanteckningar som ditt gränssnitt bör visa.

Privata filer

Signerade URL:er gäller i 10 minuter och upprätthåller fortfarande äganderätt och upplåst tillstånd.

Upplåsning kan förbruka en rättighet

Inspektera först job.unlock eller GET /usage. Anrop till upplåsningsändpunkten kan förbruka en prenumerationskvot eller befintliga bearbetningskrediter. Interna konton kan låsa upp utan kostnad. Det öppnar inte en kassa eller köp av krediter.

Slutpunktsreferens

Den kompletta v1-ytan.

OpenAPI JSON

GET/formats

Läsbara källor, skrivbara utdata och kompatibilitetsvarningar.

formats:read

GET/usage

Förhandsvisningskvot, krediter, arbetsflödeskostnader och återställningsdatum.

usage:read

GET/jobs

Kontots 50 senaste privata bearbetningsjobb.

jobs:read

POST/jobs

Skapa ett konverterings- eller bilddigitaliseringsförhandsvisningsjobb.

jobs:write

GET/jobs/conversion/{id}

Inspektera ett ägt konverteringsjobb och dess utdata.

jobs:read

GET/jobs/digitising/{id}

Inspektera ett ägt digitaliseringsjobb och dess utdata.

jobs:read

POST/jobs/{workflow}/{id}/retry

Köa om ett misslyckat jobb medan dess privata källa fortfarande finns.

jobs:write

POST/jobs/{workflow}/{id}/unlock

Lås upp ett slutfört jobb med kvot eller befintliga krediter.

jobs:write

Listningssvar

GET /formats returnerar data[] och artworkInputs[]. GET /jobs returnerar data[] plus freeUsage och är begränsad till de 50 senaste jobben.

Nya försökssvar

Nytt försök accepterar endast ett failed jobb vars källa inte har upphört. Ett lyckat nytt försök returnerar HTTP 202 med jobbet återställt till queued.

Fel och hastighetsgränser

Misslyckas tydligt. Försök igen avsiktligt.

401

Saknad, ogiltig, upphörd eller återkallad nyckel

403

Saknad funktion eller resurs tillhör en annan användare

404

Jobb eller privat fil hittades inte

409

Jobbtillstånd tillåter inte denna åtgärd

410

Källuppladdning har upphört

422

Ogiltiga fält, fil, format eller otillräcklig kvot

429

Hastighetsgräns överskriden

422 valideringsfel

{
  "message": "The format field is invalid.",
  "errors": {
    "format": [
      "Choose an output format different from every detected source format."
    ]
  }
}

60 begäranden per minut

Den allmänna gränsen gäller per API-nyckel, med ett separat nätverkstak. Uppladdnings-, bearbetnings- och upplåsningsrutter har strängare missbruksregler.

Hantera HTTP 429

Respektera Retry-After och använd exponentiell backoff med jitter. Polla inte kontinuerligt slutförda eller misslyckade jobb.

Bygger du för en AI-agent?

Använd OAuth + MCP, inte en API-nyckel.

Agentguiden innehåller anslutningsinställning, upptäckts-URL:er, OAuth PKCE, varje verktygsschema och kopieringsklara JSON-RPC-exempel.

Öppna MCP-dokumentation

Behöver du hjälp? Kontakta utvecklarstöd

Ladda ner OpenAPI-beskrivningen