How to Embed the Peaka's UI to Your Web Application

Peaka allows you to seamlessly embed its user interface into your web application. In this article, we will guide you through the steps to integrate Peaka's UI into your own application.

Prerequisites

• Partner API Key: To create a Partner API Key, please refer to our guide on managing partner API keys.

Initiate the Session

• To begin, you need to initiate a session with Peaka using your Partner API Key as the token.

curl --request GET \
    --url https://partner.peaka.studio/api/v1/ui/initSession \
    --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner.peaka.studio/api/v1/ui/initSession', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://partner.peaka.studio/api/v1/ui/initSession"
headers = {"Authorization": "Bearer <token>"}
response = requests.request("GET", url, headers=headers)
print(response.text)

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://partner.peaka.studio/api/v1/ui/initSession",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

package main

    import (
        "fmt"
        "net/http"
        "io/ioutil"
    )

    func main() {
        url := "https://partner.peaka.studio/api/v1/ui/initSession"
        req, _ := http.NewRequest("GET", url, nil)
        req.Header.Add("Authorization", "Bearer <token>")
        res, _ := http.DefaultClient.Do(req)
        defer res.Body.Close()
        body, _ := ioutil.ReadAll(res.Body)
        fmt.Println(res)
        fmt.Println(string(body))
    }

HttpResponse<String> response = Unirest.get("https://partner.peaka.studio/api/v1/ui/initSession")
.header("Authorization", "Bearer <token>")
.asString();

• The endpoint will provide a URL to initiate your session.

{
  "sessionUrl": "https://partner.peaka.studio/api/v1/ui/session?code=<session_code>"
  "partnerOrigin": "https://<partner_origin>.peaka.studio/"
}

You can access the user interface using the provided URL.

Enabling Embedded UI for Peaka Integration Using an iframe

For security reasons, you cannot use the session URL directly in an iframe. To embed Peaka within an iframe, you need to enable the embedded UI for your partner API key.

In order to do that you should;

• Go to Developer Settings in your peaka account.

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-1.png" style={{ border: "1px solid #e2e4e7" }} />

• Find your api key in the table then click ... button.

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-2.png" style={{ border: "1px solid #e2e4e7" }} />

• Select Enable Embedded UI option

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-3.png" style={{ border: "1px solid #e2e4e7" }} />

• Enable Embedded UI for this API Key

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-4.png" style={{ border: "1px solid #e2e4e7" }} />

• Enter your domain that you want to embed the Peaka app.

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-5.png" style={{ border: "1px solid #e2e4e7" }} />

  URL is needed for security reasons. Please be aware that your application should be served over HTTPS for use in an iframe.

• If you want to customize the UI, click "Customize UI Theme" button then give a theme name and upload your custom css file. You can also download the valid example of the customization file (Check out the related documentation to learn more about customization). You can add custom css files more than one and change themes in runtime.

  <img src="https://cdn.peaka.com/how-to-guides/embed-ui-6.png" style={{ border: "1px solid #e2e4e7" }} />

  After you set the css file, you should start the session with following parameters to enable custom theme.

    {
      projectId: <your_project_id>
      theme: <your_theme_name>,
      themeOverride: true
    }

Now you are ready to embed Peaka's UI into your web application using an iframe.

<iframe src="<your_session_url>" />

  iframeElement.contentWindow.postMessage(
    {
      theme: <your_theme_name>
      themeOverride: true,
    },
    partnerOrigin: <your_partner_origin>
  );