API documentation

An asynchronous REST API for protected PHP source recovery: ionCube, SourceGuardian, KingShield, Xtream Masters and XtreamAI FRIO.

Authenticate

Create an API token in your workspace and send it as a bearer token. Tokens carry the permissions of the workspace that made them.

Endpoints

POST/api/v1/scan

Scan a file without decoding it. Reports the protection system, encoder release, PHP target and which inputs a decode would ask for. Free and unmetered.

POST/api/v1/decodes

Upload a protected PHP file for recovery. Returns a job to poll.

GET/api/v1/decodes/{id}

Status of one decode: queued, inspecting, running, validating, awaiting_inputs, partial, manual_review, succeeded, not_encoded or failed.

POST/api/v1/decodes/{id}/inputs

Supply a license file, an external key, an INI key or a runtime binding the decode asked for.

POST/api/v1/uploads

Upload a ZIP or many files at once and answer their questions in one call.

POST/api/v1/uploads/{id}/unlock

Unlock a batch, with a ceiling on the credits it may spend.

GET/api/v1/decodes/{id}/output

Download the recovered PHP.