This guide introduces the common concepts that appear in Apiture Digital Banking APIs. The reader should be familiar with the basic concepts of RESTful HTTP/JSON APIs.
Authentication and Authorization
Most Apiture Digital Banking 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.
Most Apiture Digital Banking 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 Digital Banking APIs JSON representations contain a reserved
which names a run-time type profile or metadata description of that object representation.
Hypermedia Application Language (HAL)
Apiture Digital Banking 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.
Apiture Digital Banking APIs provide for API evolution and managed API versions. Learn more.
A common pattern in Apiture Digital Banking APIs concerns resources which may be in one of several
discrete states. Resource sets are abstract collections of resources
which are in the same state, and
POST operations move resources
from one state to another by adding the resource to the target resource set.
Apiture Digital Banking APIs use optimistic locking for concurrency control Learn more.
Some properties of API resource representations contain rich text in Markdown format. Learn more.
Visit Error Responses and Error Representation to see how errors which occur in REST API operation requests are represented and returned to the caller.