API Docs
Search
⌃K

Introduction

This documentation is out of date. Contact technical support for more details
iSmartFrame offers REST API so that you can programmatically integrate iSF in your application. Currently, we offer APIs for:
  1. 1.
    Manage CDN Object for purging
  2. 2.
    Manage Content of your site dynamically
  3. 3.
    Alter and edit HTML of site dynamically
  4. 4.
    Manage your profile and company information

Request and response encoding

All our APIs accept JSON-encoded request bodies and returns JSON-encoded response.

Run in Postman

We’ve created a Postman collection to make testing and working with our API simpler
Run in Postman

Error codes

API uses standard HTTP error codes.
Error Code
Description
2xx OK
Everything worked as expected.
400 Bad request
The request was unacceptable, often due to missing or invalid parameter(s). In this case a JSON-encoded error response is returned with the following properties:
401 Unauthorized
No valid API key provided.
429 Too Many Requests
Too many requests hit the API too quickly. We recommend you to throttle request rate as per the value of X-RateLimit-Limit and X-RateLimit-Reset response headers and stay within Rate Limit.
500, 502, 503, 504 Server error
Something went wrong with iSmartFrame.com API. Please create a support ticket by emailing us at [email protected].

Request ID (x-isf-requestId)

All API response contains a x-isf-requestId header. The value of this header is a unique identifier associated with the API request. If you face any issues with any API, then provide this header value in your support ticket to help us troubleshoot the issue quickly.
Last modified 1yr ago