Connect one of my accounts - Devic Documentation

Connect one of my accounts

curl --request POST \
  --url https://api.devic.ai/v1/tenant-integrations/{app}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authScheme": "API_KEY",
  "accountFields": {
    "generic_api_key": "fc-…"
  }
}
'

import requests

url = "https://api.devic.ai/v1/tenant-integrations/{app}/connect"

payload = {
    "authScheme": "API_KEY",
    "accountFields": { "generic_api_key": "fc-…" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({authScheme: 'API_KEY', accountFields: {generic_api_key: 'fc-…'}})
};

fetch('https://api.devic.ai/v1/tenant-integrations/{app}/connect', 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://api.devic.ai/v1/tenant-integrations/{app}/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authScheme' => 'API_KEY',
    'accountFields' => [
        'generic_api_key' => 'fc-…'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.devic.ai/v1/tenant-integrations/{app}/connect"

	payload := strings.NewReader("{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.devic.ai/v1/tenant-integrations/{app}/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devic.ai/v1/tenant-integrations/{app}/connect")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}"

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

{
  "connected": true,
  "authorizationUrl": "<string>"
}

POST

/

v1

/

tenant-integrations

/

{app}

/

connect

Connect one of my accounts

curl --request POST \
  --url https://api.devic.ai/v1/tenant-integrations/{app}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authScheme": "API_KEY",
  "accountFields": {
    "generic_api_key": "fc-…"
  }
}
'

import requests

url = "https://api.devic.ai/v1/tenant-integrations/{app}/connect"

payload = {
    "authScheme": "API_KEY",
    "accountFields": { "generic_api_key": "fc-…" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({authScheme: 'API_KEY', accountFields: {generic_api_key: 'fc-…'}})
};

fetch('https://api.devic.ai/v1/tenant-integrations/{app}/connect', 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://api.devic.ai/v1/tenant-integrations/{app}/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authScheme' => 'API_KEY',
    'accountFields' => [
        'generic_api_key' => 'fc-…'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.devic.ai/v1/tenant-integrations/{app}/connect"

	payload := strings.NewReader("{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.devic.ai/v1/tenant-integrations/{app}/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devic.ai/v1/tenant-integrations/{app}/connect")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authScheme\": \"API_KEY\",\n  \"accountFields\": {\n    \"generic_api_key\": \"fc-…\"\n  }\n}"

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

{
  "connected": true,
  "authorizationUrl": "<string>"
}

Authorizations

Authorization

string

header

required

An API key from your Devic console, sent as Authorization: Bearer <key>. An embedded front end sends a tenant-session token instead, so no API key reaches the browser, and an OAuth integration sends its access token. Missing, invalid or expired credentials get a 401. See Authentication.

Headers

origin

string

Sent by the browser. Used to validate returnTo.

Path Parameters

app

string

required

App slug

Query Parameters

assistantId

string

Assistant this applies to. Send exactly one of assistantId or agentId.

agentId

string

Agent this applies to. Send exactly one of assistantId or agentId.

tenantId

string

End-user tenant. Ignored when the call carries a signed tenant session, which already names the tenant.

subtenantId

string

Subtenant within the tenant.

returnTo

string

Origin the OAuth popup posts its result back to. Must match the request origin.

Body

application/json

authScheme

string

Which scheme to connect through, from GET /:app/auth

Example:

"API_KEY"

accountFields

object

What this account supplies, keyed by the scheme's accountFields

Example:

{ "generic_api_key": "fc-…" }

Response

Success

connected

boolean

required

True when the account is connected already — API-key apps have nothing to authorise, so no browser is involved

authorizationUrl

string

Open this URL in a browser to authorise the account. Absent when connected is already true