Skip to Content
PortcullisDocs
Integrate (product engineers)

Testing with the demo product

Exercise your integration end to end against a Portcullis development instance.

Portcullis development environments are seeded with a product whose code is demo, so you can test an integration before your real product is set up. Ask the Portcullis team for access to a development instance and a demo license key.

1. Get the keyring

curl -sS "https://<portcullis-api-host>/api/v1/client/keys/demo"

Put the returned kid → publicKey pairs into your test build's keyring.

2. Run the test vectors

Make your verification code pass the test vectors, including the tampered variants that must fail.

3. Walk through the scenarios

ScenarioHowExpected
Online activationActivate with the demo key200, file verifies, nonce and fingerprint match, state valid
Re-activationActivate again with the same fingerprint200 with created: false; no extra seat used
Machine limitActivate more fingerprints than the license allows409 MACHINE_LIMIT_REACHED with current and max
Wrong keyActivate with a made-up key404 LICENSE_NOT_FOUND
Check-inRun a check-in with licenseKey and licenseFileId200, fresh file with a later exp
Server unreachablePoint PORTCULLIS_URL at an unreachable hostProduct keeps running on its current file and retries with backoff
SuspensionAsk staff to suspend the test license, then check in200 with a signed file whose status is suspended; product enters restricted mode
Reinstatement / renewalAsk staff to reinstate or renew, then check inProduct returns to valid
License key rotationAsk staff to rotate the key, then check inCheck-in still succeeds via licenseFileId
Tampered fileChange one character in the stored file's payloadState invalid
OfflineGenerate a .req, have staff process it, import the .licFile verifies with the pending nonce, state valid
Offline renewalHave staff issue a new file for the same machine; import itAccepted because its iat is newer
DeactivationDeactivate from your admin screen200 { deactivated: true }; file deleted; state not_activated

Inspecting files

Digicom staff can paste or upload any .lic or .req file into the console's Inspect license file tool. It decodes the contents, checks the signature and the signing key's status, and links to the matching license or machine. Ask the Portcullis team when a file doesn't behave as expected.

On this page