The Be-Bound Developer Hub

Welcome to the Be-Bound developer hub. You'll find comprehensive guides and documentation to help you start working with Be-Bound as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting started

This article explains the basic steps to integrate Be-Bound Technology in your Server. The main factors to consider:

  • HTTP Messaging: There are very few requirements for your Server. The Messages sent through Be-Bound Network (or proxy) are delivered to your remote application server (or WebHook) using HTTPs Post requests (cf. please refer to the below section).

  • E2EE: Be-Bound Technology provides an optional feature to enable End-to-End Encryption (E2EE) between your mobile/IoT App and your application Server. In this, case we provide a Server SDK to handle the data encoding and decoding at your server side.

👍

Connection between Be-Bound Network and your Server

Be-Bound requires some details of your server (URL or Webhook and authentication token) to establish a connection between Be-Bound Network and your Server. You can configure those details through Be-Bound Console. See more details here.

HTTP Post Messaging

Once the webhooks of your Server have been properly configured on the console, any message sent through Be-Bound Network (or proxy) will be delivered to your Server using HTTP Post Requests, as discussed in the following subsections.

HTTP Headers

Specific Be-Bound HTTP metadata are (or should be) defined in these HTTP post requests, as listed below:

HTTP Header

Description

Content-Type

Four main content types are supported by Be-Bound based on the data payload type (e.g. clear, signed, encrypted, etc.):

  • application/vnd.bebound+json
  • application/vnd.bebound+binary;type=encrypted
  • application/vnd.bebound+json;type=signed
  • application/vnd.bebound+binary;type=signed,encrypted

Authorization

HTTP Basic Auth encoded in Base64 and formatted as follows: Basic Base64(BeAppUUID : WebHookToken)

Beapp-Message

Name of the BeApp Message as defined in your BeApp Manifest (XML file)

Beapp-Version

Version number (integer) of your BeApp as defined in the console

Device-Id

UUID of the remote Device (e.g. smartphone or IoT device)

Beapp-Signature

Digital signature of the BeApp Message encoded in Base64

HTTP Body

Be-Bound messages are transmitted within the body of HTTP Post requests, according to two main formats, as discussed below:

  • JSON: BeApp message is transmitted as a JSON object (i.e. Content-Type = application/vnd.bebound+json or application/vnd.bebound+json;type=signed) and whose JSON keys shall be parameter names as defined in your BeApp Manifest. These messages are already decoded and ready to be processed by your application.

  • Binary: BeApp message is transmitted as a binary data (i.e. Content-Type = application/vnd.bebound+binary;type=encrypted or application/vnd.bebound+binary;type=signed,encrypted). These messages are generally encoded and encrypted (i.e. E2EE feature enabled). First, you need to decrypt those messages using your security algorithms and secret keys. Then, Be-Bound Server SDK should be used to decode the decrypt the message into a JSON object that can be processed by your application.

Updated about a year ago


Getting started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.