Concepts

This guide introduces the common concepts that appear in Apiture APIs. The reader should be familiar with the basic concepts of RESTful HTTP/JSON APIs.

Authentication and Authorization

Most Apiture API operations require authentication and check if the authenticated user is authorized to perform the operation. See more details in Secure Access.

Resources and URI Structure

Resources and URI Structure describes how clean URIs refer to resources that are organized as collections of instances. The root resource of an API allows for discoverability of the resources within and the operations on those resources.

Collections

Most Apiture APIs divide their resources into collections which contain instances. Learn more at Collections, collection pagination, collection filtering and searching, and collection sorting.

Schemas and Profiles

Apiture APIs JSON representations contain a reserved _profile property which names a run-time type profile or metadata description of that object representation. Learn more.

Hypermedia Application Language (HAL)

Apiture APIs use Hypermedia Application Language (HAL) format for both request response bodies. Learn more.

Links allow one representation to refer to other resource or to operations that apply to the resource that contains the link. This allows hypermedia-driven APIs, a key component of REST APIS. Learn more.

Versioning

Apiture APIs provide for API evolution and managed API versions. Learn more.

Concurrency Control

Apiture APIs use optimistic locking for concurrency control Learn more.

Markdown

Some properties of API resource representations contain rich text in Markdown format. Learn more.

Errors

Visit Error Responses and Error Representation to see how errors which occur in REST API operation requests are represented and returned to the caller.