Skip to main content
The Integration System gives you many options for interfacing programmatically with the backend. This API gives you access to the metadata behind your portal content as well as the ability to update content and run integration commands. Before you do, though, you’ll need an API Key and the endpoint!

​
1. Obtaining an API Key

To access the API, you will need an API key. You can create an API Key in the /backend area of your portal. API Keys are managed in Settings -> API Keys

​
2. Accessing the API

Once you have an API Key, you can access the API through the “api” folder on your portal’s URL. For example: https://yourportal.example.com/api/v1/portal/upgrade?apikey=my_api_key_here

​
3. API Response

All of the Integration System’s APIs return JSON. You can convert this easily to an array in most languages. (json_decode, for example, in PHP) You can also use Curator’s backend to generate links to the various Curator API endpoints
  1. Login to the backend of your Curator instance (e.g. http://curatorexample.com/backend).
  2. Navigate to the Settings > Curator > API Keys section from the left-hand menu.
  3. Change the dropdowns in the REST API to the respective endpoint you would like to try.
  4. Use the preview link generated below the dropdowns to start using the endpoint. Note: Some variables may be missing from these preview links.

​
Restrict an API Key to Specific Endpoints

By default, an API key can call every Curator API endpoint. You can limit a key to the endpoints it needs.
  1. Log in to the backend of your Curator instance (e.g. http://curatorexample.com/backend).
  2. Navigate to the Settings > Curator > API Keys section from the left-hand menu, and open the API key.
  3. Turn on the Restrict Access? switch. The API Endpoints section opens below it.
  4. The section shows one card for each API path, such as Portal or User. Each card lists the endpoints of that path with a check box for each one. A checked box means the key can call that endpoint. Clear the check box of each endpoint the key must not call.
  5. Save the API key.
Use the Allow all and Deny all links to change many check boxes at once. The links on a card change only the endpoints of that card. The links in the toolbar above the cards change every endpoint. The Denied: line at the bottom of each card lists the endpoints of that card that are not checked. When a restricted key calls a denied endpoint, Curator does not run the request. It returns this JSON response:
Curator stores the list of denied endpoints, not the list of allowed endpoints. When a Curator upgrade adds a new endpoint, a restricted key can call it until you clear its check box. Review the API key after each upgrade.
If you turn off Restrict Access?, the key can call every endpoint again. Curator keeps the denied list, so the same endpoints are denied if you turn the switch back on.