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, 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 why APIs matter is that they are necessary for your site, app, or service. APIs are one of the most common pieces of middleware that you’ll encounter in software. You need them to process an order and confirm payment if you are selling anything. You need them to collect data if that is the goal of your solution.

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

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:

  1. Sign in to your ReadyCMS account
  2. Hover over the Settings dropdown menu (in the main menu/navigation bar) with your mouse
    Managing API access-1
  3. Go to Settings > API
  4. This will take you to the API Access settings page
    Managing API access-0
  5. App ID is your unique id for your ReadyCMS instance. Its value is fixed (can not be changed) and it is used to identify your ReadyCMS instance
    Managing API access-3
  6. App Secret is something like a password. Goes in pair with App ID and serves the purpose of authenticating with the API.
    Managing API access-4
    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.
  7. Namespace is a subdomain of your ReadyCMS instance.
    Managing API access-5
    This value is required for API authentication as well, and it's used with App ID and App Secret to provide better security.
  8. You can specify the domain in the Domains text field if you want to restrict the access to your data
    Managing API access-6
    If you leave it blank, there will be no restrictions.
  9. (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)
    Managing API access-7
  10. In the Privacy field, you can insert the link to the privacy policy on your website
    Managing API access-8
  11. In the Terms of service field, you can insert the link to the terms of service on your website
    Managing API access-9
  12. Click the Save button to confirm the changes

Related topics:



Help us improve our documentation

Suggest changes or request new documentation

Suggest changes