API for integrations
Leia estudos, resultados e respostas de fora do UXTap com chaves só de leitura.
1 minute read
On this page
Connect an integration using a key and read scopes.
Purpose
Query authorized data outside the UXTap interface.
When to use it
To bring studies and results into your own integration.
Before you start
- Administrator permission and required authentication
- A server-side secret store
Example
Query studies using read:studies and follow the next-page cursor.
Step by step
- Open API for integrations. In Settings, open API for integrations. Read the OpenAPI contract to choose required data and filters. /openapi.json.
- Create a minimal key. Use New key, set a name, scopes and expiry. Confirm your password when requested; follow email password creation if your account needs it. read:studies · read:results · read:sessions only if needed.
- Store and query. Store the one-time displayed key on your server. Send Authorization: Bearer in /api/v1 queries and follow cursors until no next page remains. No key in the browser · Cursor pagination.
- Monitor usage. Check daily usage in the card and handle 429 according to retry-after. Revoke unused keys and update the integration after rotation. Insufficient scope · Expiry · Limit.
How to read the result
- A key with defined expiry and scopes
- Read queries and monitorable usage
Cautions and limitations
- The API is read-only and does not use cookies or URL keys.
- read:sessions may include answer text; grant it only if needed.
- Changing a password or signing out all devices may revoke keys.
Continue with the interactive guide
Related guides
Was this helpful?
Is something missing? Write to contato@uxtap.app.