Connect an app account
curl --request GET \
--url https://api.aisa.one/apis/v1/connector/connect/{app} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/connector/connect/{app}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/connector/connect/{app}', 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.aisa.one/apis/v1/connector/connect/{app}",
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://api.aisa.one/apis/v1/connector/connect/{app}"
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://api.aisa.one/apis/v1/connector/connect/{app}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/connector/connect/{app}")
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{
"connectSessionId": "<string>",
"connectUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Connect
Connect an app account
Starts connecting an app account through the AIsa hosted page for one of your end users. Send the end user to connectUrl, then poll the connect session. connectionId reauthorizes one of the end user's connections in place.
<!-- aisa-pricing:start -->
No charge.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
connector
/
connect
/
{app}
Connect an app account
curl --request GET \
--url https://api.aisa.one/apis/v1/connector/connect/{app} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/connector/connect/{app}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/connector/connect/{app}', 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.aisa.one/apis/v1/connector/connect/{app}",
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://api.aisa.one/apis/v1/connector/connect/{app}"
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://api.aisa.one/apis/v1/connector/connect/{app}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/connector/connect/{app}")
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{
"connectSessionId": "<string>",
"connectUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: GET /apis/v1/connector/connect/{app}
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/connector/connect/{app} - app: path; required
- externalUserId: query; required
- redirectUrl: query; optional
- connectionId: query; optional
- Runtime facts: b83047fcbad985ec640307ba4d7ee6b8b135df80af28491269fd477fef52cd1d
{
"operationId": "get_aisa_connector_apis_v1_connector_connect_app",
"method": "GET",
"path": "/apis/v1/connector/connect/{app}",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"in": "path",
"name": "app",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Your id for the end user the account belongs to.",
"in": "query",
"name": "externalUserId",
"required": true,
"schema": {
"maxLength": 250,
"minLength": 1,
"type": "string"
}
},
{
"description": "Where the browser goes when the flow ends; it must be on your redirect allowlist.",
"in": "query",
"name": "redirectUrl",
"required": false,
"schema": {
"format": "uri",
"type": "string"
}
},
{
"description": "One of the end user's connections to reauthorize.",
"in": "query",
"name": "connectionId",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "No AIsa charge applies to this operation.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
No charge. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Your id for the end user the account belongs to.
Required string length:
1 - 250Where the browser goes when the flow ends; it must be on your redirect allowlist.
One of the end user's connections to reauthorize.