Application Embedding

This embedding does not have an UI button that user can use to manually open the app. The app can send a link, leading to its embedding to any location (Instant Messenger, Feed and etc.). To use this embedding option, the link must have the format /marketplace/view/#APP_CODE#/, where #APP_CODE# - your app code.

The embedding can receive any number of parameters in the "get" key params, for example: /marketplace/view/#APP_CODE#/?params[test]=y. In this case, PLACEMENT_OPTIONS is as follows:

 [
'test' = 'y'
]

[url=/marketplace/view/'.$myApp['CODE'].'/?params[test]=y]uri[/url]

<?
$placement = 'REST_APP_URI';
$url = 'https://example.com/placement.php';
CRest::call(
  'placement.bind',
  [
      'PLACEMENT' => $placement,
      'HANDLER' => $url
  ]
);
?>

The example above registers an embedding location on your portal. It can be registered only once on the portal for this PLACEMENT, and it becomes available for calling. You can place your embedding in your application:

<a href="/marketplace/view/<?=$myApp['CODE']?>/">uri</a>

And place it in a Feed post:

<?
    CRest::call('log.blogpost.add',
        [
            'POST_TITLE' => 'Post Title',
            'POST_MESSAGE' => 'use this [url=/marketplace/view/'.$myApp['CODE'].'/?params[test]=y]uri[/url]',
            'DEST' => [ 'EN' ]
        ]);
?>

Send it via bot to chat for a user via the method:

<?
CRest::call(
    'imbot.message.add',
    [
        'DIALOG_ID' => 1,
        'MESSAGE' => 'use this [url=/marketplace/view/'.$myApp['CODE'].'/?params[test]=y]uri[/url]',

    ]
);
?>

The link can be embedded in any text field which supports BBCode or inside your other embedding locations as a standard link. The GET parameter params can be used to modify the displayed parameters in the embedding. You can use this option in any various scenarios by passing any number of parameters into GET key params, for example: ?params[test]=yy.

• errorHandlerUrl - required field with error handler URL. When the embedding upload takes a long period of time (longer than 3-5 seconds), this URL receives a message with text and error code and the embedding itself is deleted.

Registration example:

CRest::call(
    'placement.bind',
    [
        'PLACEMENT' => 'PAGE_BACKGROUND_WORKER',
        'HANDLER' => 'http://portal.johns.bx/johns/placement/?ty=1',
        'OPTIONS' => [
            'errorHandlerUrl' => 'http://portal.johns.bx/johns/logg.php?ty=1',
        ],
        'LANG_ALL' => [
            'en' => [
                'TITLE' => 'test',
            ]
        ]
    ]
);

This embedding location supports:

special JS methods and events for embedding a third-party WebRTC client. Learn more here.

• registration for individual users.