API Integration

API Integration

Accessing CMS content through an API

Source CMS provides robust API capabilities that enable you to access and manipulate content programmatically. With this functionality, you can build custom applications, integrate with other systems, or create headless experiences using your content.

JSON:API

The primary API for Source CMS is based on the JSON:API specification, which provides a standardized way to request and manipulate resources.

JSON:API is a specification for building APIs that:

• Use JSON as the data format
• Provide a consistent structure for requests and responses
• Define clear conventions for filtering, sorting, and pagination
• Allow for including related resources in a single request
• Support sparse fieldsets to limit the data returned

Resources

In the context of Source CMS, API resources include:

• Content: Articles, pages, and custom content types
• Media: Images, documents, videos
• Taxonomy terms: Categories, tags, and other classifications
• Users: Account information for authenticated users
• Menus: Navigation structure

Each resource is identified by its type and unique ID, and includes attributes (the resource's properties) and relationships (connections to other resources).

In the context of Source CMS, API resources include:

• Content: Articles, pages, and custom content types
• Media: Images, documents, videos
• Taxonomy terms: Categories, tags, and other classifications
• Users: Account information for authenticated users
• Menus: Navigation structure

Each resource is identified by its type and unique ID, and includes attributes (the resource's properties) and relationships (connections to other resources).