Enabling the API

Enabling the API

In Source CMS, the JSON:API is enabled by default. However, you might need to configure specific settings for your use case.

Configuring allowed operations

From the following operations, you can control which operations are permitted on your content:

• GET: Retrieve resources (always enabled)
• POST: Create new resources
• PATCH: Update existing resources
• DELETE: Remove resources

Use the following steps to configure allowed operations:

1. Access your site.
2. In the left sidebar, click API > JSON:API.
3. In the Allowed operations section, select the desired access level:
   • Read-only: Only allows GET operations
   • Read and write: Allows all operations on all resources
4. Click Save configuration.

Configuring public access

By default, API access requires authentication. However, you can enable public access if needed.

Use the following steps to configure public access: 

1. Access your site.
2. In the left sidebar, click API > JSON:API.

3. In the Public access section, select the desired option:

   • Select Yes to enable public access.
   • Select No to disable public access.

   Enabling anonymous access requires careful consideration of security implications.

1. Access your site.
2. In the left sidebar, click API > JSON:API.

3. In the Public access section, select the desired option:

   • Select Yes to enable public access.
   • Select No to disable public access.

   Enabling anonymous access requires careful consideration of security implications.