Start connecting a user
curl --request POST \
--url https://api.circuit.org/partner/connections \
--header 'Content-Type: application/json' \
--header 'circuit-partner-version: <circuit-partner-version>' \
--data '
{
"app": "<string>",
"recipientPublicKey": "<string>"
}
'import requests
url = "https://api.circuit.org/partner/connections"
payload = {
"app": "<string>",
"recipientPublicKey": "<string>"
}
headers = {
"circuit-partner-version": "<circuit-partner-version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'circuit-partner-version': '<circuit-partner-version>',
'Content-Type': 'application/json'
},
body: JSON.stringify({app: '<string>', recipientPublicKey: '<string>'})
};
fetch('https://api.circuit.org/partner/connections', 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.circuit.org/partner/connections",
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([
'app' => '<string>',
'recipientPublicKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"circuit-partner-version: <circuit-partner-version>"
],
]);
$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.circuit.org/partner/connections"
payload := strings.NewReader("{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("circuit-partner-version", "<circuit-partner-version>")
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.circuit.org/partner/connections")
.header("circuit-partner-version", "<circuit-partner-version>")
.header("Content-Type", "application/json")
.body("{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circuit.org/partner/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["circuit-partner-version"] = '<circuit-partner-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}API Reference
Start connecting a user
POST
/
partner
/
connections
Start connecting a user
curl --request POST \
--url https://api.circuit.org/partner/connections \
--header 'Content-Type: application/json' \
--header 'circuit-partner-version: <circuit-partner-version>' \
--data '
{
"app": "<string>",
"recipientPublicKey": "<string>"
}
'import requests
url = "https://api.circuit.org/partner/connections"
payload = {
"app": "<string>",
"recipientPublicKey": "<string>"
}
headers = {
"circuit-partner-version": "<circuit-partner-version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'circuit-partner-version': '<circuit-partner-version>',
'Content-Type': 'application/json'
},
body: JSON.stringify({app: '<string>', recipientPublicKey: '<string>'})
};
fetch('https://api.circuit.org/partner/connections', 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.circuit.org/partner/connections",
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([
'app' => '<string>',
'recipientPublicKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"circuit-partner-version: <circuit-partner-version>"
],
]);
$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.circuit.org/partner/connections"
payload := strings.NewReader("{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("circuit-partner-version", "<circuit-partner-version>")
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.circuit.org/partner/connections")
.header("circuit-partner-version", "<circuit-partner-version>")
.header("Content-Type", "application/json")
.body("{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circuit.org/partner/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["circuit-partner-version"] = '<circuit-partner-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"app\": \"<string>\",\n \"recipientPublicKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}Headers
Allowed value:
"0.1"Body
application/json