Files
help365/platform/360009921431.html
2025-05-27 21:32:35 +04:00

212 lines
18 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>APIs in apps</title>
<meta name="generator" content="Help+Manual" />
<meta name="keywords" content="" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="BRIX API is a tool used to integrate BRIX with external systems." />
<meta name="picture" content="" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
<meta property="og:url" content="https://brix365.com/en/help" />
<meta property="og:image" content="" />
<link rel="icon" href="favicon.png" type="image/png" />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
<link rel="stylesheet" href="./jquery-ui.min.css" />
<link rel="stylesheet" href="default.css" />
<link rel="stylesheet" href="./search-yandex.css" />
<link rel="stylesheet" href="./article.css" />
<link rel="stylesheet" href="./glossary.css" />
<link rel="stylesheet" href="./theme.css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="helpman_settings.js"></script>
<script type="text/javascript" src="helpman_topicinit.js"></script>
<script type="text/javascript" src="highlight.js"></script>
<script type="text/javascript">
$(document).ready(function(){highlight();});
</script>
</head>
<body>
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
<header class="header elma-365">
<div class="container">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-en.svg" alt="header logo">
</a>
<!-- <div class="hero__search-form" id="search-panel">
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
<label class="search-form__label">
<span id="reset-search" class="search__icon"></span>
<input class="search-form__input" type="text">
</label>
<input class="search-form__submit" type="submit" value="Submit">
</form>
</div> -->
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
<div class="hero__search">
<a href="#" id="search-icon" class="hero__search-icon">
<img src="search-icon-white.svg" alt="search string">
</a>
<a href="#" id="side-menu-icon" class="hero__side-icon">
<img src="side_menu.svg" alt="side menu">
</a>
</div>
<div class="header__navi">
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
</div>
</div>
</header>
<main class="main container">
<aside class="sidebar" id="sidebar">
<div class="sidebar__header">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-light-en.svg">
</a>
<span class="sidebar__close elma-365-close" id="close"></span>
</div>
<div class="sidebar__wrapper" id="side-menu">
</div>
</aside>
<article class="article" id="article">
<div class="article-inner">
<div class="content">
<header class="article__header">
<div class="article__bread" style="display:flex; gap:10px;">
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
<div class="topic__breadcrumbs">
<p>Low-code designer &gt; App builder / APIs in apps</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1" style="text-align: center; line-height: 1.20; margin: 19px 0 19px 0;"><span class="f_Heading1" style="font-size: 32px;">API in apps</span></h1>
</div>
</header>
<section class="article__content">
<div class="scroll-top-inner">
<a href="#h1-article" class="scroll-top"></a>
</div>
<!-- Placeholder for topic body. -->
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><span style="font-weight: bold;">BRIX API </span>is a tool used to integrate BRIX with external systems.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">With API methods you can create and edit app items or obtain data from them using just one request.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Read more about API methods<span style="font-weight: bold;"> </span>in <a href="https://api.brix365.com/en/public-api/guides/IntroWebAPI/" target="_blank" class="weblink">BRIX Public API</a>.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">The <span style="font-weight: bold;">API</span> page in an app allows you to test the requests that you write.</p>
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">API page in apps</span></h2>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">To open the <span style="font-weight: bold;">API</span> page, click the <img alt="app gear icon" width="20" height="21" style="margin:0;width:20px;height:21px;border:none" src="hmfile_hash_f96bd8e3.png"/> icon next to the app<span style="font-family: Inter;"></span>s name and select <span style="font-weight: bold;">API</span> in the menu.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="app-api-1" width="544" height="581" style="margin:0;width:544px;height:581px;border:none" src="app-api-1.png"/></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">The API page of an app displays:</p>
<ul style="list-style-type:disc">
<li style="line-height: 1.20;">Available functions. For more information, please visit <a href="https://api.brix365.com/en/public-api/reference/app/" target="_blank" class="weblink">BRIX Public API</a>.</li><li style="line-height: 1.20;">Description<span style="font-weight: bold;"> </span>of each function.</li><li style="line-height: 1.20;">The method name.</li><li style="line-height: 1.20;">Request URL for the app.</li><li style="line-height: 1.20;">Request template.</li><li style="line-height: 1.20;">Possibility to test the request that you write.</li></ul>
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading3" style="font-size: 19px;">Request template</span></h3>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">You can find the request template on the <span style="font-weight: bold;">JSON Package</span> tab.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"><img alt="api_apps_01" width="1056" height="683" style="margin:0;width:1056px;height:683px;border:none" src="api_apps_01.png"/></p>
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading3" style="font-size: 19px;">Test a request</span></h3>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">You can test your request on the <span style="font-weight: bold;">Test </span>tab.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">In the <span style="font-weight: bold;">Body </span>field, enter your request and click <span style="font-weight: bold;">Send</span>.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"><img alt="api_apps2" width="598" height="387" style="margin:0;width:598px;height:387px;border:none" src="api_apps2.png"/></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">You will see the response to your request in the <span style="font-weight: bold;">Response </span>field.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="api_apps3" width="783" height="375" style="margin:0;width:783px;height:375px;border:none" src="api_apps3.png"/></p>
<p class="p_Normal"><a class="dropdown-toggle" style="font-style: normal; font-weight: normal; color: #000000; background-color: transparent; text-decoration: none;" href="javascript:HMToggle('toggle','TOGGLE0186A1')">Example of testing a request</a></p>
<div id="TOGGLE0186A1" class="dropdown-toggle-body" style="text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="border:none; border-spacing:0;">
<tr>
<td style="vertical-align:top; padding:0; border:none"><p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Select the <span style="font-weight: bold;">Get Item</span> function and enter the ID of the app item in the <span style="font-weight: bold;">Identifier</span> field.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="app_api_01" width="977" height="720" style="margin:0;width:977px;height:720px;border:none" src="app_api_01.png"/></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Click <span style="font-weight: bold;">Send</span>. You will see the result of the request in the <span style="font-weight: bold;">Response </span>field.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="app_api_02" width="1005" height="457" style="margin:0;width:1005px;height:457px;border:none" src="app_api_02.png"/></p>
</td>
</tr>
</table>
</div>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="360007529451.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">360007529451.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="limit-selection-of-elements.html">
<span class="bottom-nav__link">limit-selection-of-elements.html</span> <span
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
</a>
</div>
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
</section>
</div>
<aside class="article__sidebar" style="display:none">
<input type="checkbox" />
<div class="article__arrow"></div>
<div class="table-of-contents elma365-right" id="toc2Content">
<h3 class="h3-toc">In this topic</h3>
<nav id="toc2"></nav>
</div>
</aside>
</div>
</article>
</main>
<footer class="footer">
<div class="footer-container">
<div class="footer-mobile">
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
</div>
<div class="footer-wrap">
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
<div class="footer-flex-b">
<span class="footer-copy">&copy; 2025 BRIX</span>
<ul class="footer-list">
<li class="footer-item">
<a href="#" class="arrow-top" style="display: block;"></a>
</li>
</ul>
</div>
</div>
</div>
</footer>
<iframe name="hmnavigation" style="display:none!important"></iframe>
<script src="./jquery-ui.js"></script>
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
<script src="./jquery.tocify.min.js"></script>
<script src="./TypoReporter.min.js"></script>
<script src="./google-search.js"></script>
<script src="./main.js"></script>
<script type="text/javascript">
HMInitToggle('TOGGLE0186A1','hm.type','dropdown','hm.state','0');
</script>
</body>
</html>