Swift

CorsairCloud is a small Swift client for a hosted Corsair Cloud project. It uses URLSession and async/await. Give it your API key, and every plugin your runtime has is callable over HTTP.

1. Install

Add it to your Package.swift. The package lives under clients/swift in the corsair monorepo. Until a root-level Swift mirror ships, add it as a local path dependency from a checkout of corsair:

.package(path: "../corsair/clients/swift"),
// then in your target: .product(name: "CorsairCloud", package: "CorsairCloud")

2. Add your API key

Copy your project’s API key (ck_cloud_…) from the dashboard Overview page. Keep it on a server; don’t ship it inside an app you distribute. The client derives its own URL from the key:

import CorsairCloud

let corsair = CorsairCloud(apiKey: ProcessInfo.processInfo.environment["CORSAIR_CLOUD_KEY"]!)

3. Make a call

Pick a user (a “tenant”), then call any operation on any plugin your runtime has:

let result = try await corsair.tenant("acme").call("notion", "pages.searchPage", args: ["query": "roadmap"])

tenant("acme") runs the call as your user “acme”. By default result is a JSONValue. To get a typed result, pass your own Decodable and Corsair decodes it for you:

struct Page: Decodable { let id: String }
struct SearchResult: Decodable { let results: [Page] }

let typed = try await corsair.tenant("acme")
    .call("notion", "pages.searchPage", as: SearchResult.self)

4. Connect a user’s account

A tenant can only call Notion after they have connected their Notion account. Create a connect link and send the user to it:

let link = try await corsair.manage.createConnectLink(plugin: "notion", tenantId: "acme")
// open link.connectUrl

After they authorize, check who is connected:

let status = try await corsair.manage.connectionStatus(tenantId: "acme")
// ["notion": "connected"]

try await corsair.manage.disconnect(plugin: "notion", tenantId: "acme")

Handle errors

Any non-2xx response throws CorsairError:

do {
    _ = try await corsair.tenant("acme").call("notion", "pages.searchPage", args: [:])
} catch let error as CorsairError {
    if error.code == "not_connected" {
        // send the user through createConnectLink first
    }
}

Its fields: code (machine reason, branch on this), status (HTTP status), message, and the upstream provider’s status when the error came from them.

Get Started

Frameworks

Adapters

Workflows (beta)

Reference

1. Install

2. Add your API key

3. Make a call

4. Connect a user’s account

Handle errors

​1. Install

​2. Add your API key

​3. Make a call

​4. Connect a user’s account

​Handle errors

1. Install

2. Add your API key

3. Make a call

4. Connect a user’s account

Handle errors