Connectors

Test a custom API connector

Send one request to a custom API’s test URL with the credential attached, without storing anything. Pass connection_id to test a stored connector, filling in only the fields you want to override. The stored credential is only sent to the connector’s stored base_api_url or test_url origin (scheme, host and port); to test against any other origin, send the access_token again. The outcome is in the 200 body: credential failures are status: error, not an HTTP error. Requires full access.

POST

oauth

connections

custom_api

test

Test a custom API connector

curl --request POST \
  --url https://api.sprites.dev/v1/oauth/connections/custom_api/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "sk-live-...",
  "auth_custom_header_name": "X-Api-Key",
  "auth_header_prefix": "Bearer",
  "auth_method": "header",
  "auth_query_param_name": "api_key",
  "auth_url_path_template": "/bot{token}",
  "base_api_url": "https://api.acme.example",
  "connection_id": "conn_abc123",
  "test_url": "https://api.acme.example/me"
}
'

import requests

url = "https://api.sprites.dev/v1/oauth/connections/custom_api/test"

payload = {
    "access_token": "sk-live-...",
    "auth_custom_header_name": "X-Api-Key",
    "auth_header_prefix": "Bearer",
    "auth_method": "header",
    "auth_query_param_name": "api_key",
    "auth_url_path_template": "/bot{token}",
    "base_api_url": "https://api.acme.example",
    "connection_id": "conn_abc123",
    "test_url": "https://api.acme.example/me"
}
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({
    access_token: 'sk-live-...',
    auth_custom_header_name: 'X-Api-Key',
    auth_header_prefix: 'Bearer',
    auth_method: 'header',
    auth_query_param_name: 'api_key',
    auth_url_path_template: '/bot{token}',
    base_api_url: 'https://api.acme.example',
    connection_id: 'conn_abc123',
    test_url: 'https://api.acme.example/me'
  })
};

fetch('https://api.sprites.dev/v1/oauth/connections/custom_api/test', 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.sprites.dev/v1/oauth/connections/custom_api/test",
  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([
    'access_token' => 'sk-live-...',
    'auth_custom_header_name' => 'X-Api-Key',
    'auth_header_prefix' => 'Bearer',
    'auth_method' => 'header',
    'auth_query_param_name' => 'api_key',
    'auth_url_path_template' => '/bot{token}',
    'base_api_url' => 'https://api.acme.example',
    'connection_id' => 'conn_abc123',
    'test_url' => 'https://api.acme.example/me'
  ]),
  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.sprites.dev/v1/oauth/connections/custom_api/test"

	payload := strings.NewReader("{\n  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\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.sprites.dev/v1/oauth/connections/custom_api/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sprites.dev/v1/oauth/connections/custom_api/test")

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  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\n}"

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

{
  "result": {
    "latency_ms": 42,
    "message": "HTTP 200 — Connection OK",
    "status": "ok"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Custom API connector test request

access_token

string

Credential to test. Required unless connection_id supplies the stored one, which it does only for a request to the connector's stored origins.

Example:

"sk-live-..."

auth_custom_header_name

string

Header name for auth_method custom_header.

Example:

"X-Api-Key"

auth_header_prefix

string

Prefix for the Authorization header value when auth_method is header.

Example:

"Bearer"

auth_method

enum<string>

Where the credential is placed. See the create request for each method. Defaults to header.

Available options:

header,

url_path,

query_param,

custom_header

Example:

"header"

auth_query_param_name

string

Query parameter name for auth_method query_param.

Example:

"api_key"

auth_url_path_template

string

Path template for auth_method url_path.

Example:

"/bot{token}"

base_api_url

string

Base URL of the provider API. Used to build the request when auth_method is url_path.

Example:

"https://api.acme.example"

connection_id

string

Existing custom API connector to test. When set, omitted or blank fields fall back to the connector's stored credential and settings, so a stored connector can be re-tested without resending its token. The stored credential is only sent to the connector's stored base_api_url or test_url origin (scheme, host and port); testing against any other origin needs access_token.

Example:

"conn_abc123"

test_url

string

URL fetched with the credential attached. For auth_method url_path give a path relative to base_api_url (such as /me); the request joins base_api_url, the token path and this value, so an absolute URL here would be appended to the base URL. For every other method give an absolute URL. Required unless connection_id supplies a stored test URL. URLs that resolve to internal addresses are rejected.

Example:

"https://api.acme.example/me"

Response

Success

Custom API connector test response

result

object

required

Test outcome.

Show child attributes

Example:

{
  "latency_ms": 42,
  "message": "HTTP 200 — Connection OK",
  "status": "ok"
}

⌘I

Test a custom API connector

curl --request POST \
  --url https://api.sprites.dev/v1/oauth/connections/custom_api/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "sk-live-...",
  "auth_custom_header_name": "X-Api-Key",
  "auth_header_prefix": "Bearer",
  "auth_method": "header",
  "auth_query_param_name": "api_key",
  "auth_url_path_template": "/bot{token}",
  "base_api_url": "https://api.acme.example",
  "connection_id": "conn_abc123",
  "test_url": "https://api.acme.example/me"
}
'

import requests

url = "https://api.sprites.dev/v1/oauth/connections/custom_api/test"

payload = {
    "access_token": "sk-live-...",
    "auth_custom_header_name": "X-Api-Key",
    "auth_header_prefix": "Bearer",
    "auth_method": "header",
    "auth_query_param_name": "api_key",
    "auth_url_path_template": "/bot{token}",
    "base_api_url": "https://api.acme.example",
    "connection_id": "conn_abc123",
    "test_url": "https://api.acme.example/me"
}
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({
    access_token: 'sk-live-...',
    auth_custom_header_name: 'X-Api-Key',
    auth_header_prefix: 'Bearer',
    auth_method: 'header',
    auth_query_param_name: 'api_key',
    auth_url_path_template: '/bot{token}',
    base_api_url: 'https://api.acme.example',
    connection_id: 'conn_abc123',
    test_url: 'https://api.acme.example/me'
  })
};

fetch('https://api.sprites.dev/v1/oauth/connections/custom_api/test', 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.sprites.dev/v1/oauth/connections/custom_api/test",
  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([
    'access_token' => 'sk-live-...',
    'auth_custom_header_name' => 'X-Api-Key',
    'auth_header_prefix' => 'Bearer',
    'auth_method' => 'header',
    'auth_query_param_name' => 'api_key',
    'auth_url_path_template' => '/bot{token}',
    'base_api_url' => 'https://api.acme.example',
    'connection_id' => 'conn_abc123',
    'test_url' => 'https://api.acme.example/me'
  ]),
  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.sprites.dev/v1/oauth/connections/custom_api/test"

	payload := strings.NewReader("{\n  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\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.sprites.dev/v1/oauth/connections/custom_api/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sprites.dev/v1/oauth/connections/custom_api/test")

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  \"access_token\": \"sk-live-...\",\n  \"auth_custom_header_name\": \"X-Api-Key\",\n  \"auth_header_prefix\": \"Bearer\",\n  \"auth_method\": \"header\",\n  \"auth_query_param_name\": \"api_key\",\n  \"auth_url_path_template\": \"/bot{token}\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"connection_id\": \"conn_abc123\",\n  \"test_url\": \"https://api.acme.example/me\"\n}"

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

{
  "result": {
    "latency_ms": 42,
    "message": "HTTP 200 — Connection OK",
    "status": "ok"
  }
}

Connectors

Sprites

Checkpoints

Exec

Filesystem

Network Policy

Services

Usage

Websockets

Test a custom API connector

Authorizations

Body

Response