Create a key
Open API keys, choose permissions and an expiry. Save the secret when it appears; it is shown once.
Build around
your workflow.
Create invitations. Read results. Keep your tools in sync.
API v1OpenAPI 3.0.3HTTPS · JSON
Create an invitation
Your integration gets a one-time scan link and PIN. The scanner opens Terms & Privacy first. After the player chooses Accept, the PIN fills in and the scan starts automatically.
Retrieve the result
Check invitation status, then read the completed report. Reports expire after seven days.
BASE URL
https://screenshareac.org/apiAuthentication
Send your key in the Authorization header on each request. API keys need an active license and only grant access to their owner's scans.
Authorization: Bearer YOUR_API_KEYKeep the key on your server.
Do not put it in browser code, URLs or public repositories. Restrict source IPs and grant only the permissions you need.
| Permission | Access |
|---|---|
user:read | Read your account and license status |
scan:create | Create scan invitations |
scan:read | Check invitations, list and retrieve your reports |
scan:publish | Publish a report or return it to private |
Keys expire after at most 365 days or at the end of a dated license, whichever comes first. Lifetime licenses have no expiry, but their API keys still expire after the selected period. Account removal, a blacklist or license expiry revokes access; renewing a license does not restore revoked keys. You or an administrator can revoke an individual key at any time.
Errors & limits
Errors use a JSON object with an error string. Check the HTTP status before reading the result.
| Status | Meaning |
|---|---|
400 | Missing or invalid request values |
401 | Missing, invalid, expired or revoked key |
403 | Permission, source IP, account or license does not allow this request |
404 | Report unavailable, expired or not owned by this account |
409 | State changed or the report predates public-sharing consent |
429 | Rate limit reached. Back off before retrying. |
503 | A required service is temporarily unavailable |
Invitations are single use and expire after 24 hours. Reports are retained for seven days. A PIN is a lookup value, never an authentication credential. Historical PIN lookup can return multiple reports.
Poll invitation status at a sensible interval and stop when it completes or expires. Follow hasMore and increment page when listing results. Do not retry failed mutations blindly.