Skip to content

API Reference

The Apptork Root System embraces modern API development standards. All endpoints, parameters, request payloads, and standardized error responses are automatically mapped and exposed using OpenAPI 3 specifications via drf-spectacular.

Interactive Documentation Interfaces

We provide two distinct, interactive UI frameworks to explore the API, built directly into the core routing.

Swagger provides a highly interactive playground. You can inject JWT tokens, populate request bodies, and execute real queries against the API directly from your browser.

Open Swagger UI

ReDoc offers a beautiful, three-panel, static reading experience. It is ideal for sharing with front-end developers who need a clean, comprehensive overview of the available payloads and error codes without necessarily executing requests inline.

Open ReDoc

Authentication in Swagger

To test protected endpoints in the Swagger UI, you must authenticate.

  1. Obtain a JWT: Use the /api/v1/auth/... endpoints (e.g., OTP verify) to generate an access token.
  2. Authorize: Click the green Authorize button at the top right of the Swagger interface.
  3. Inject: Paste your token into the jwtAuth field. (You do not need to type "Bearer ", just the raw JWT string depending on configuration).
  4. Execute: You can now freely execute requests against protected endpoints like /api/v1/wallets/me/.

The Raw Schema

If you are utilizing code generation tools (like openapi-generator for Dart/Flutter or Typescript/Vue.js), you can download the raw JSON/YAML specification file directly:

Schema URL: http://localhost:8000/api/schema/

Security Warning

In a true production environment, you must consider disabling these routes behind an administrative feature flag or firewall to prevent exposing your complete internal schema to the public internet.