Developers & API

What is an API?

An API, or Application Programming Interface, allows one application to request information or services from another application in a structured way.

For Austi Classics Pro, APIs can provide a way for other software to work with supported texts, references, annotations and related features without requiring users to perform each action manually.

Who is the API for?

The API is intended primarily for developers, education technology providers and organisations that want to integrate Austi Classics Pro with another application or service.

What can the API be used for?

Available capabilities depend on the API features currently enabled, but possible uses include:

• Finding supported books, plays and other texts.
• Retrieving structured text content.
• Working with chapters, acts, scenes, verses and other references.
• Retrieving supported annotation sets and notes.
• Connecting external learning tools to Austi Classics Pro.
• Building services that link directly to particular passages.

Structured text references

Austi Classics Pro stores texts in a structured form so that applications can identify specific parts of a work.

The available reference structure depends on the type of text. For example, a play may use acts, scenes and lines, while the Bible may use books, chapters and verses.

This structure allows external applications to request or link to a more precise location than an entire book or chapter.

Annotations through the API

Where supported, API clients can work with annotation sets associated with Austi Classics Pro texts.

Annotations remain linked to specific text locations, allowing an external service to retrieve notes relevant to a passage.

Getting access

Some API features may require authentication or other access credentials.

When API access is available, developers should use the credentials and authentication method provided for their integration.

Keep API credentials private. Do not place secret keys or credentials directly in public frontend code, public repositories or shared documents.

API requests and responses

API requests are normally sent to a specific endpoint representing the information or service required.

Responses are returned in a structured format that can be processed by the calling application.

Full technical documentation should be used when implementing an integration, as it will describe the available endpoints, request parameters, authentication requirements and response formats.

Errors and troubleshooting

If an API request does not work as expected, check:

• The endpoint address is correct.
• The required parameters have been supplied.
• The text or reference being requested exists.
• Authentication credentials are present and valid where required.
• The request uses the expected format.
• The response status and error message for additional detail.

Usage and permissions

API access does not automatically grant permission to redistribute all content available through Austi Classics Pro.

Developers should comply with any applicable API terms, content licences, copyright requirements and usage limits for the material they access.

Technical documentation

This Help page provides a general introduction to the API. Detailed developer documentation can provide endpoint-by-endpoint guidance, request examples, data formats and authentication instructions.

As the Austi Classics Pro API expands, this section can link directly to the current technical documentation.

Potential integration examples