Jump to content

Guides

Creating an API Key

The IPS Community Suite REST API provides a way for you to remotely interface with the content of your community.

To get started, you need to create API key. Log into your Admin CP and go to System -> REST API. You may be prompted to download a .htaccess file to route API requests - follow the on screen instructions until you are shown this screen:

Screen Shot 2015-12-11 at 14.01.34.png

Click the "Create New" button to create an API key, and fill out the form.

Warning

The REST API provides access to low-level functions and has the potential to cause significant damage to your community. Never share your API key and make sure that the source code for your API implementation is well protected.  We also recommend locking your API key to the IP addresses which you will send requests from.

 

Warning
Both to prevent accidental damage, and for additional security, only enable the endpoints you intend to use. In this guide, we will be demonstrating the GET /core/hello endpoint.

 

Tip
It's a good idea to enable logging, especially for endpoints which actually take action (like posting, editing or deleting content). You can configure how long logs are kept for under the API Logs tab.

 

 

  Report Guide


×