APIs

APIs provide a flexible way to call the V2 APIs connector. For ways to create V2 APIs, refer to the documentation.

Note

v3 version uses the open capability of HTTP API when calling general APIs.

---

API Usage Reference

interface apis {
  [apisLabel: string]: {
    [
      method: "request" | "post" | "get" | "head" | "patch" | "delete" | "put"
    ]: (
      callApiOptions: ICallApiOptions,
      opts?: IRequestOptions
    ) => Promise<ResponseObject["data"]>;
  };
}

The APIs module supports the following HTTP methods:

Method name	Description	Sample code
get	GET request	apis["apisLabel"].get(callApiOptions)
post	POST request	apis["apisLabel"].post(callApiOptions)
put	PUT request	apis["apisLabel"].put(callApiOptions)
delete	DELETE request	apis["apisLabel"].delete(callApiOptions)
head	HEAD request	apis["apisLabel"].head(callApiOptions)
patch	PATCH request	apis["apisLabel"].patch(callApiOptions)
request	Custom method request	apis["apisLabel"].request(callApiOptions)

Note

apisLabel is the APIs flag, generated when creating a V2 version APIs connector. You can view it in basic information of the connector.

参数

callApiOptions

ICallApiOptions

pathstring

Request path, the identification of a method in a certain APIs connector

method可选string

HTTP method (used when apis["apisLabel"].request method)

headers可选Record<string, any>

Custom request header

body可选Record<string, any> | string

Custom Request Body

token可选string

Access token, defaults to the token of the currently logged-in user

opts

IRequestOptions

Request object parameter, does not need to pass in, includes url, method, headers, body, as a supplement to customization needs, will override parameters with the same name in callApiOptions

返回

res

ResponseObject['data']

data content in the API response

示例

Initialization Configuration

import cloudbase from "@cloudbase/js-sdk";

Initialize a CloudBase app
const app = cloudbase.init({
env: "your-env-id", // Replace with your environment ID
region: "ap-shanghai", // Region, default is Shanghai
accessKey: "", // Fill in the generated Publishable Key
});

Retrieve the apis instance
const apis = app.apis;

Basic APIs Call

Call the methodLabel method of the connector named "apisLabel" APIs with a POST call
async function getUserProfile(userId: string) {
  try {
    const result = await apis["apisLabel"].post({
      path: "methodLabel",
      body: { userId },
    });
console.log("Call success:", result);
    return result;
  } catch (error) {
console.error("call failed:", error);
    throw error;
  }
}

// Call the methodLabel method of the connector named "apisLabel" APIs using a GET call
async function getProductList(category: string) {
  try {
    const result = await apis["apisLabel"].get({
      path: "methodLabel",
      body: { category },
    });
    return result;
  } catch (error) {
console.error("call failed:", error);
    throw error;
  }
}

Advanced Configuration Example

// Custom request configuration
async function customApiCall() {
  const result = await apis["apisLabel"].request({
method: "PUT", // Specify HTTP method
path: "methodLabel", // API path
    headers: {
      "X-Custom-Header": "value",
    },
    body: {
      data: "custom data",
    },
  });
  return result;
}

// Use different HTTP methods
async function multiMethodExample() {
// POST request
  const createResult = await apis["apisLabel"].post({
    path: "methodLabel",
    body: { name: "New Item" },
  });

// GET request
  const getResult = await apis["apisLabel"].get({
    path: "methodLabel",
  });

// DELETE request
  const deleteResult = await apis["apisLabel"].delete({
    path: "methodLabel",
  });
}

Basic Error Handling

async function safeApiCall() {
  try {
    const result = await apis["apisLabel"].post({
      path: 'methodLabel'
      body: { data: "test" },
    });
    return result;
  } catch (error) {
// Handle API invocation error
    if (error.code === "INVALID_PARAMS") {
console.error("Parameter error:", error.msg);
    } else {
console.error("API call failure:", error);
    }
    throw error;
  }
}

---