Views: 5154
Last Modified: 22.12.2023

   Creating an app

Archive with example contains SDK CRest and two files. They comprise a finished app that queries REST API, integrates pop-up dialogs into contact lists within CRM companies as well as displays CRM object selected by user.

Attention! This example works based on SDK CRest. Before using this example, open the file checkserver.php via browser and check if your server settings are correct. You need to inherit CRest class for actual public application by re-defining methods getSettingData/setSettingData, that are get/save authentication tokens into text file. These methods are not intended for app operation on several Bitrix24 simultaneously. Learn more.

Download the archive:

To create a solution to be further published in Application catalog, select New application and choose an area for publishing your future new app inside your own developer's account. The new slider menu allows you to choose or create a new app version:

Fill out the available sections (1) for this example by inputting "CRM", "Users", "Application embedding".

Contrary to local applications, public apps have versions. Each version is submitted for moderation. (During moderation, app description is checked as well). Moderation is not required at the development and testing stage, you are developing and finalizing your app's fully featured package, including test instances on your Bitrix24 accounts and only after that you should submit your app to be moderated by Bitrix24 team.

When creating a new solution you need to fill out the app name (1), app ID code (2), categories (3), app description (4), price policy (5) and click test (6):

Description of required fields (click on plus symbol)

Proceed to saving app details, by filling all the required fields. First step is complete, i. e. you have prepared description portion of your future application.

  Application testing

To test your application, click on Test button in the app version or Test inside the app :

Indicate the Bitrix24 test account (1) and click on "Install" (2). After Bitrix24 app is installed, you will see "Application not found" message. It's a normal situation, because our example has enabled "Use Rest API" option and the app hasn't been published in a public catalog yet. When your app becomes available in the  Applications catalog, Bitrix24 will keep user at the app description page.

Go to the list of contacts or companies. Any contact or company context menu has "Applications" submenu that now has the item "Public embedded form" , that opens slider with application.

Application shows debugging information about passed authentication data of current user, as well as contact (or company, when calling it from CRM company list) data. The app gets such data via REST API using the authentication data. Because this application works within Bitrix24 interface and uses authentication of current user who has opened this app, the app works exclusively within this user access permissions.

Courses developed by Bitrix24