Instart provides RESTful APIs that allow you to interact with our cloud-based Digital Experience Management Platform. They allow you to do anything you can do with our customer portal web interface and more. Requests can be sent and responses received via any standard method in most common programming languages, with your favorite REST client, or from the command line using cURL.
The API base URL is unique customer API name>/v1/
where you would of course use your own unique customer API name instead of the placeholder. This is displayed in the portal at the top of the Home page in the box displaying your account's properties.
There are two ways you can authenticate:
Use an Authorization header. First construct a string consisting of your username, a colon (:), and your password, as in this example:
Then Base64-encode the string. Use the encoded string in theAuthorizationheader by using the word "Basic" followed by a space and your Base64-encoded string, like this example:
Use the Session API to get a session ID, using the same base64-encoded authorization string described above. You can then use the session ID with any other API requests as the value of a cookie named authtoken. For example:
If anything does not work as expected or you have any questions, please contact us via our Support portal.
|Account Management||allows you to manage your account, users, and billing options and to create, list, update and delete properties. A property represents a group of closely-related web resources for a customer.|
|Session Management||allows you to create, update and delete authenticated sessions. A session can be used as a cookie value to authenticate to future requests.|
|Configuration Management||allows you to create, update, and delete property configurations. A property configuration defines the details of how the service controls the handling of your web traffic through our service.|
The Property Configuration Guide provides details on configuration structure and how to configure service features, etc.
|Cache Management||allows you to purge all or part of your cache on our service.|
|Delivery Stats||allows you to retrieve aggregated web delivery and performance statistics from our data platform. |
The Delivery Stats API Guide provides details and examples on how to make delivery stats queries.
|Security Stats||allows you to retrieve raw security event log data from the last three days, and aggregated security statistics from our data platform. |
The Security Stats API Guide provides details and examples on how to make security stats queries.
|Activity Reporting||allows you to retrieve information about tasks – long running operations – for example, when you issue a purge request, the API creates a task object for it.|