API

The SecDim API is a RESTful API that allows enterprise customers to programmatically access platform data and manage their tenant.

The API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

What You Can Do with the API

  • Reporting — retrieve user engagement data, challenge completion statistics, scores, and skill proficiency metrics for your organisation

  • User Management — create, update, and remove users from your tenant programmatically

  • Game Management — query games, challenges, and pathway data

  • Export — generate custom reports and analytics for your organisation’s learning data

Authentication

The SecDim API uses API keys to authenticate requests.

  • API keys can be viewed and managed in the Enterprise Dashboard

  • All API requests must be made over HTTPS — calls over plain HTTP will fail

  • API requests without authentication will fail

Your API keys carry many privileges. Keep them secure. Do not share API keys in publicly accessible areas such as GitHub, client-side code, or public repositories.

OpenAPI Schema

The API is compatible with the OpenAPI (Swagger) specification. The full API schema is provided to enterprise customers upon request and can be used with any OpenAPI-compatible tool for exploration and testing.

Access

API access is available to enterprise customers. To get started:

  1. Contact your SecDim account manager or email support@secdim.com

  2. You will receive your API key and the OpenAPI schema documentation

  3. Use the schema to explore available endpoints, request/response formats, and parameters

See Also