Custom API

Call external REST APIs securely.

The CustomApiResourceClient allows you to make HTTP requests to external APIs that you have configured as connectors in Major.

Usage

import { myApiClient } from "./clients";

const result = await myApiClient.invoke("POST", "/v1/orders", "create-order", {
  body: { type: "json", value: { productId: "p_123", quantity: 1 } },
  headers: { "X-Custom-Auth": "secret" },
  query: { currency: "USD" },
});

if (result.ok) {
  console.log("Status:", result.result.status);
  if (result.result.body.kind === "json") {
    console.log("Response:", result.result.body.value);
  }
}

Inputs

The invoke method accepts the following arguments:

method · string · required

The HTTP method to use: "GET", "POST", "PUT", "PATCH", or "DELETE".

path · string · required

The URL path to append to the resource’s base URL.

invocationKey · string · required

A unique identifier for this operation.

options · object

Optional configuration object.

Show properties

query · Record<string, string | string[]>

Query parameters to append to the URL.

headers · Record<string, string>

Additional HTTP headers to send with the request.

body · BodyPayload

The request body. Can be JSON, text, or bytes.

Show BodyPayload

type · "json" | "text" | "bytes" · required

value · unknown

Required for json/text types.

base64 · string

Required for bytes type.

contentType · string

Required for bytes type.

timeoutMs · number

Timeout in milliseconds (default: 30000).

Outputs

On success (ok: true), the result object contains:

kind · "api"

Discriminator for the response type.

status · number

The HTTP status code returned by the API.

body · ResponseBody

The response body.

Show ResponseBody

kind · "json" | "text" | "bytes"

value · unknown

Present for json/text types.

base64 · string

Present for bytes type.

contentType · string

Present for bytes type.