Retrieve an Embedded Integration - Versori User Documentation

GET

embed

{hub_id}

users

{user_id}

integrations

{integration_id}

Retrieve an Embedded Integration

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}",
  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"
)

func main() {

	url := "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "imageUrl": "<string>",
  "description": "<string>",
  "isDeployed": true,
  "isActivated": true,
  "connectionTemplates": [
    {
      "id": "<string>",
      "connectorId": "<string>",
      "imageUrl": "<string>",
      "name": "<string>",
      "isUsed": true,
      "isPrimary": true,
      "authSchemeConfig": {
        "id": "<string>",
        "description": "<string>",
        "schemeType": "none",
        "validationMessages": [
          {
            "text": "<string>",
            "severity": "info",
            "detail": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "variablesSchema": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

hub_id

string<ulid>

required

user_id

string

required

UserID references an End User in the Hub.

Most APIs support setting this value to either the internal Versori identifier or their external ID as determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is being used.

integration_id

string<ulid>

required

Query Parameters

identifier_type

enum<string>

default:external

IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an external identifier. If the value is external, some endpoints also require the hub query parameter to identify the correct Hub.

Available options:

internal,

external

Response

EmbeddedIntegration represents an integration that is available to an end user and contains all the necessary information for the UI to determine how the user should activate the integration.

string<ulid>

required

ID is the unique identifier for the Integration

name

string

required

Name is a short name for the integration, this is typically the name of the Connector being integrated to.

imageUrl

string<uri>

required

ImageURL is a URL to an image/icon that represents the integration. This image is used within the integration tile displayed in the embedded UI.

description

string

required

Description can be used to provide a longer description of the integration. This can be shown to end users in the embedded integration hub UI.

isDeployed

boolean

required

IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the integration cannot be activated.

isActivated

boolean

required

IsActivated indicates whether the integration is activated for the end user. If the integration is not activated, the user can activate it from the embedded integration hub.

connectionTemplates

object[]

required

ConnectionTemplates is a list of connections that the end user can authenticate to when activating the integration.

Show child attributes

variablesSchema

object

VariablesSchema is the JSON schema for the variables defined for this integration.

⌘I

Retrieve an Embedded Integration

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}",
  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"
)

func main() {

	url := "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations/{integration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "imageUrl": "<string>",
  "description": "<string>",
  "isDeployed": true,
  "isActivated": true,
  "connectionTemplates": [
    {
      "id": "<string>",
      "connectorId": "<string>",
      "imageUrl": "<string>",
      "name": "<string>",
      "isUsed": true,
      "isPrimary": true,
      "authSchemeConfig": {
        "id": "<string>",
        "description": "<string>",
        "schemeType": "none",
        "validationMessages": [
          {
            "text": "<string>",
            "severity": "info",
            "detail": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "variablesSchema": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}