Create a custom API connector

POST

oauth

connections

custom_api

curl --request POST \
  --url https://api.sprites.dev/v1/oauth/connections/custom_api \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "sk-live-...",
  "base_api_url": "https://api.acme.example",
  "name": "acme-api",
  "access_policy": {
    "allow_all": true
  },
  "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}",
  "description": "Acme production account",
  "refresh_token": "rt-...",
  "test_url": "https://api.acme.example/me"
}
'

import requests

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

payload = {
    "access_token": "sk-live-...",
    "base_api_url": "https://api.acme.example",
    "name": "acme-api",
    "access_policy": { "allow_all": True },
    "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}",
    "description": "Acme production account",
    "refresh_token": "rt-...",
    "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-...',
    base_api_url: 'https://api.acme.example',
    name: 'acme-api',
    access_policy: {allow_all: true},
    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}',
    description: 'Acme production account',
    refresh_token: 'rt-...',
    test_url: 'https://api.acme.example/me'
  })
};

fetch('https://api.sprites.dev/v1/oauth/connections/custom_api', 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",
  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-...',
    'base_api_url' => 'https://api.acme.example',
    'name' => 'acme-api',
    'access_policy' => [
        'allow_all' => true
    ],
    '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}',
    'description' => 'Acme production account',
    'refresh_token' => 'rt-...',
    '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"

	payload := strings.NewReader("{\n  \"access_token\": \"sk-live-...\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"sk-live-...\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\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")

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  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\n  \"test_url\": \"https://api.acme.example/me\"\n}"

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

{
  "connection": {
    "id": "conn_abc123",
    "provider": "slack"
  }
}

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 request

access_token

string

required

Credential sent to the provider. Stored encrypted and never returned by the API.

Example:

"sk-live-..."

base_api_url

string

required

Base URL of the provider API. Gateway paths are appended to it when a sprite calls the connector.

Example:

"https://api.acme.example"

name

string

required

Connector name. This is the connector's unique identity within the organization: creating a second custom API connector with the same name updates the existing connector in place rather than creating another one.

Example:

"acme-api"

access_policy

object

Initial access policy. Empty or missing policies deny sprite use until updated.

Show child attributes

Example:

{ "allow_all": true }

auth_custom_header_name

string

Header that carries the credential when auth_method is custom_header. Defaults to X-Api-Key. Reserved hop-by-hop and identity headers are rejected.

Example:

"X-Api-Key"

auth_header_prefix

string

Prefix for the Authorization header value when auth_method is header. Defaults to Bearer. An empty string sends the bare credential.

Example:

"Bearer"

auth_method

enum<string>

Where the credential is placed on provider requests. header sends an Authorization header prefixed by auth_header_prefix; url_path substitutes it into auth_url_path_template; query_param adds it as the auth_query_param_name query parameter; custom_header sends it as the auth_custom_header_name header. Defaults to header.

Available options:

header,

url_path,

query_param,

custom_header

Example:

"header"

auth_query_param_name

string

Query parameter that carries the credential when auth_method is query_param. Defaults to api_key.

Example:

"api_key"

auth_url_path_template

string

Path segment inserted between base_api_url and the requested path when auth_method is url_path. {token} is replaced with the credential.

Example:

"/bot{token}"

description

string

Free-form description shown in the dashboard.

Example:

"Acme production account"

refresh_token

string

Optional refresh token stored alongside the credential. Stored encrypted and never returned.

Example:

"rt-..."

test_url

string

URL the connector test fetches with the credential attached. For auth_method url_path give a path relative to base_api_url (such as /me), because the test joins base_api_url, the token path and this value; for every other method give an absolute URL. Stored for later tests; creating a connector does not run the test.

Example:

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

Response

Created

Connector response

connection

object

required

Sanitized connector. Secrets and encrypted token fields are never returned.

Show child attributes

Example:

{ "id": "conn_abc123", "provider": "slack" }

⌘I

Create a custom API connector

curl --request POST \
  --url https://api.sprites.dev/v1/oauth/connections/custom_api \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "sk-live-...",
  "base_api_url": "https://api.acme.example",
  "name": "acme-api",
  "access_policy": {
    "allow_all": true
  },
  "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}",
  "description": "Acme production account",
  "refresh_token": "rt-...",
  "test_url": "https://api.acme.example/me"
}
'

import requests

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

payload = {
    "access_token": "sk-live-...",
    "base_api_url": "https://api.acme.example",
    "name": "acme-api",
    "access_policy": { "allow_all": True },
    "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}",
    "description": "Acme production account",
    "refresh_token": "rt-...",
    "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-...',
    base_api_url: 'https://api.acme.example',
    name: 'acme-api',
    access_policy: {allow_all: true},
    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}',
    description: 'Acme production account',
    refresh_token: 'rt-...',
    test_url: 'https://api.acme.example/me'
  })
};

fetch('https://api.sprites.dev/v1/oauth/connections/custom_api', 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",
  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-...',
    'base_api_url' => 'https://api.acme.example',
    'name' => 'acme-api',
    'access_policy' => [
        'allow_all' => true
    ],
    '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}',
    'description' => 'Acme production account',
    'refresh_token' => 'rt-...',
    '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"

	payload := strings.NewReader("{\n  \"access_token\": \"sk-live-...\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"sk-live-...\",\n  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\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")

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  \"base_api_url\": \"https://api.acme.example\",\n  \"name\": \"acme-api\",\n  \"access_policy\": {\n    \"allow_all\": true\n  },\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  \"description\": \"Acme production account\",\n  \"refresh_token\": \"rt-...\",\n  \"test_url\": \"https://api.acme.example/me\"\n}"

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

{
  "connection": {
    "id": "conn_abc123",
    "provider": "slack"
  }
}

Connectors

Sprites

Checkpoints

Exec

Filesystem

Network Policy

Services

Usage

Websockets

Create a custom API connector

Authorizations

Body

Response