Progress will discontinue Telerik Platform on May 10th, 2018. Learn more
  • Getting Started with the Backend Services RESTful API

Getting Started with the Backend Services RESTful API

Getting Started with the Backend Services RESTful API

The Backend Services RESTful API provides a universal way of using the Backend Services components of Telerik Platform from any platform that can send HTTP or HTTPS requests. It exposes the complete set of APIs available to the app developer.

Usage

To use the Backend Services RESTful API you need to be able to send HTTP or HTTPS requests. Use your favorite library to make RESTful calls from your app code or a tool such as curl or Postman for manual calls.

The general structure of a call URL is as follows:

https://api.everlive.com/v1/{your-app-id}/{resource}

where

Some operations need elevated authorization using the API Master Key. You can find more about the App ID and the API Master Key in Introduction to Security.

Examples:

https://api.everlive.com/v1/ToKkyrLbF9O6CGiC/Users/c7de8580-23da-11e5-b49c-dfce2a329730
https://api.everlive.com/v1/Metadata/Applications/ToKkyrLbF9O6CGiC/Types

HTTP Verbs

Using different HTTP verbs with the same URL yields different results.

For example using the GET verb with https://api.everlive.com/v1/ToKkyrLbF9O6CGiC/Users/ reads all user accounts; using the POST verb creates a new user account provided the required data as an HTTP header.

Verb usage is always specified with each RESTful API.

HTTP Headers

Some operations require passing data using HTTP headers, including industry standard headers and custom headers.

Information about the custom X-Everlive- headers that you can use is presented in List of Request Parameters.

Error Codes

When you request a RESTful API operation that cannot be executed by Telerik Platform you get an error code in the response to let you know where the problem lays. Some of these error codes are mapped to standard HTTP status codes.

See List of Response Error Codes to learn more about what each error code means and when it is returned.

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.