A InkSmith Press egy fordított HTTP API-t tesz közzé a közös sablonokra és a gyártási feladatokra. A Press Control az Asztalban ugyanazt a kezelési határt használja. Az API az engedéllyel rendelkező ügyfeleknek szól, a helyi asztali munkához nem szükséges.
Fedezze fel az esetet
A Press telepítés felfedi a GET /health, GET /ready és GET /api/v1/instance-at. Használja a készség és a felfedezés, hogy ellenőrizze az API verzió, renderer kompatibilitás, és elfogadott sablon séma elküldése előtt munka.
A kiszolgálónak a beállított HTTPS átjáró mögött kell ülnie távoli használatra. Kövesse a Press telepítési útmutató Docker és Windows Service opciók.
Az ügyfél hitelesítése és hatóköre
Küldj Authorization: Bearer <token>-t védett kérésekre. Az API ügyfelei csak a szükséges távcsöveket kapják meg. A rendereléshez a vonatkozó engedélyek a renders.create, jobs.read és outputs.read. A menedzsment távlatok közé tartozik a templates.read, templates.write és templates.publish.
Tárolja a kiadott hitelesítő külső sablonok, forrásellenőrzés, és böngésző JavaScript. A Press az API-kliens megbízólevelet tárolja, mint hashest, és támogatja az azonnali visszavonást.
Beadás és visszaszerezni egy render munka
Csak aktív közzétett sablont lehet megadni. Jellemző kérés:
POST /api/v1/render-jobs
Authorization: Bearer <token>
Content-Type: application/json
Idempotency-Key: invoice-1042
{"template_id":"<published-template-id>","data":{"customer":{"name":"Ada"}}}
A munka aszinkron. Olvassa el a GET /api/v1/render-jobs/:id, amíg a státusz completed, failed, vagy cancelled. Miután befejeződött, a GET /api/v1/render-jobs/:id/output visszaadja a PDF-öt, ha a hívó outputs.read-os.
Ismételje meg ugyanazt az idempotencia kulcsot egy bizonytalan hálózati hiba után csak ugyanazon kérelem és hitelesség. A módosított bemenettel újrahasználva 409 idempotency_conflict keletkezik.
A sablonok felülvizsgálata
Gyűjtemények, sablonok, tervezetek, verziók és kiadványok server- tulajdonában. A tartalomtovábbítások tervezete a application/vnd.inksmith.template-t használja. A megtakarítások és a közzététel a If-Match-ben szereplő jelenlegi átláthatatlan felülvizsgálatot igényli; a 412 template_revision_conflict-t egy áttetsző frissítési tervezet kapja. A közzétett változat változhatatlan. A közzététel megszüntetése és visszaállítása a külön kiadvány felülvizsgálatán alapul.
Lásd a Press Control-t az Asztalszerkesztési munkafolyamatnál. A Press telepítési útmutató magyarázza a támogatott hosting útvonalakat és a jelenlegi korlátokat.
Jelenlegi hatály: Interaktív felhasználó és szerep adminisztráció, tanúsítvány beiratkozás, és néhány retenciós ellenőrzés még fejlesztés alatt áll. A közzétett API-t és az engedélyezési ellenőrzéseket szerződésként kezeljék; ne kerüljék meg őket közvetlen adatbázismódosításokkal.