Bitrix24 REST API

General information

Bitrix24 Marketplace

In this help you will learn the basic principles of the development of applications for Bitrix24 and the procedure you will have to undertake to register you application in Marketplace. For developers whose applications may require third party access to private resources, we shall discuss the principles of operation of the OAuth authentication server, and take a look at some examples.

Bitrix24 App design guidelines

For the convenience of the users of your service, we recommend that you create the app using a standardized formulation. Recommendations for formation can be downloaded here.

Notes on Bitrix24 App Development

All Bitrix24 applications may fit in the following three major categories.

Types can be combined in one application. An application can work from a third party server, use frames, and at the same time work from the “outside” using OAuth authorization to obtain access to Rest API.

An application can be structured as required by design, however:

For security reasons, an application is embedded in the Intranet pages using IFRAME. IFRAME loads the URL specified when registering the application. If the application was uploaded as an archive, the URL is obtained from the Bitrix website.

To save a user the trouble of logging in again in IFRAME, a special authentication code is passed on the URL (using the OAuth authentication server).

IFRAME is not allowed to access the parent window by design. While it is extremely advantageous from a security standpoint, it brings about development issues. To overcome these restrictions, you can use the JavaScript library. For example:

To use REST or other features in a client side script, include the JS Library. Applications of the second kind can use REST at server side, because the authentication key will be passed on to the entry point (or installer) as the POST parameters AUTH_ID and AUTH_EXPIRES.

The library needs to be included before it can be used.

The REST methods are available for the following data items:

When registering your application in Marketplace, you will have to select the data items your applications will access and use – that is, assign user data access permissions.

Important! The date and time fields are read and written in ISO 8601 format.

When you start developing your application, one of the first steps to take is register and install it on your testing installation of Bitrix24. It is only then that you can try to run your app on a real Bitrix24 service.

© 2001-2017 Bitrix, Inc. Bitrix® is a registered trademark of Bitrix, Inc. Powered by Bitrix Site Manager