Managing API access

What is an API?

API (application programming interface) is a computing interface that defines interactions between multiple software intermediaries. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc.

In other words, an API is a toolset that programmers can use to help them create software. Simply put, an API specifies how software components should interact. Or, even simpler, an API is something that sends information back and forth between a website or app and a user.

Why is API important?

The first reason APIs matter is that they are necessary for your site, app, or service. APIs are one of the most common pieces of middleware you’ll encounter in software. You need them to process an order and confirm payment if you sell anything. You need them to collect data if that is the goal of your solution.

The second reason is that APIs are nowadays packaged as products that developers can use to build your site or app, add value, or find a new way to deliver value for the systems you build.

Tip:
Good APIs make it easier to develop a computer program by providing all the building blocks, which are then put together by the programmer.

How to manage API access in ReadyCMS

API access in ReadyCMS is defined on the API settings page:

Login: Sign in to your ReadyCMS account
Navigate: Go to Settings > API
API Access: This will take you to the API Access settings page
App ID is the unique ID for your ReadyCMS instance. Its value is fixed (can not be changed), and it is used to identify your ReadyCMS instance
App Secret is something like a password. It goes in pairs with the App ID and serves the purpose of authenticating with the API.

Tip:
You can change the App Secret but make sure you know what you are doing. If you change the App Secret without updating the code of your connected application, your application will not be able to connect to API, therefore it will not work.
Namespace is a subdomain of your ReadyCMS instance.

This value is also required for API authentication, and it's used with App ID and App Secret to provide better security.
If you want to restrict access to your data, you can specify the domain in the Domains text field.

If you leave it blank, there will be no restrictions.
(Optional) You can enter the email address that will appear in the response as part of the "Contact the administrator" message (if there's an API error or bad authentication)
In the Privacy field, you can insert the link to the privacy policy on your website.
In the Terms of Service field, you can insert the link to the terms of service on your website.
Click the Save button to confirm the changes.