Developer API

Call the tools from your own software without a browser: send a request, start a job and download the output. All endpoints live at a single versioned address; every request is authorised with a personal key.

Job flow

One call starts a conversion job and gives you a job ID. With that ID you query the job status and download the output once it is done. Jobs can take a while, so this split lets clients wait without blocking their flow.

Key and access

Requests are signed with the Authorization: Bearer header. Create your key in your account and revoke it whenever you like; the plain-text key is shown only at the moment it is created. A browser session does not count as auth here.

Tools with an open API surface

ToolAPI surfaceDocument
KargoLabelConverter — POST /runDocument
Gelir-Gider Defteri10 endpoints (stateful app)Document
GörselKüçültConverter — POST /runDocument
PdfSplitConverter — POST /runDocument

Versioning and contract

Endpoints are versioned under https://api.pixepi.com with /api/v1; a backwards-incompatible change requires a new version. The machine-readable contract is published as OpenAPI 3.1 and can be fed directly to client generators.

Responses and errors

Responses are in a JSON envelope; every job is queried by its own ID and record ownership is checked on the server. When something goes wrong, the response returns a code that describes the state; the client translates that code into its own language.

Going deeper