Integration overview

Updated at:

Alongside its visual console, Office Security Platform provides OpenAPI and Alibaba Cloud SDKs to help you develop and deploy applications more efficiently.

OpenAPI

To help developers learn and use cloud product APIs quickly and efficiently, Alibaba Cloud provides OpenAPI Explorer. This tool integrates features such as intelligent API search, documentation, online debugging, SDK acquisition, code samples, error diagnostics, and call statistics. In OpenAPI Explorer, you can call the APIs of various Alibaba Cloud services and view the requests and responses. OpenAPI Explorer also automatically generates SDK code examples to help you get started. For more information, see What is OpenAPI?.

Versions

Alibaba Cloud OpenAPI uses versions to manage the API lists for major product releases. For example, Office Security Platform currently supports the API list for version 2023-01-20. The string 2023-01-20 is a version identifier, not a date. It indicates that the displayed APIs are the most current and does not mean that the APIs have remained unchanged since 2023-01-20.

Version

Description

2023-01-20

Recommended

Online debugging

Before calling an API, familiarize yourself with its version, endpoints, style, and calling methods.

You can debug APIs at https://api.aliyun.com/api/csas/2023-01-20. The debugging page in OpenAPI Explorer is divided into three sections: an API navigation tree on the left (for example, the currently selected ListIdpConfigs API, which queries IdP configuration information), a parameter configuration panel in the middle, and request parameter documentation on the right. The middle panel includes a Service Address drop-down list (such as China (Hangzhou)), input parameters such as Include (the specified IdP configuration type), CurrentPage (the current page number), and PageSize (the number of entries per page), and a Send Request button.

Endpoints

To minimize latency, choose the endpoint that corresponds to the region where your resources are located. For example, for Office Security Platform in the China (Hangzhou) region, the public endpoint is csas.aliyuncs.com and the VPC endpoint is csas-vpc.cn-hangzhou.aliyuncs.com.

  • Public endpoints are globally accessible.

  • VPC endpoints are accessible only from within a VPC in the corresponding Alibaba Cloud region. VPC endpoints have several advantages:

    • High security: VPC endpoints are accessible only from within a VPC, providing greater security and privacy.

    • Faster response times: Because VPC endpoints operate on the internal VPC network, they typically offer faster response times than public endpoints and can avoid issues like public network latency and bandwidth limitations.

    • Lower costs: VPC endpoints use internal network traffic for communication.

For more information, see Service endpoints.

Supported identities

By default, OpenAPI Explorer uses your logged-in Alibaba Cloud account for API calls. This practice poses a high security risk because an Alibaba Cloud account has full permissions for all APIs. We strongly recommend that you create and use a RAM user for API access and daily O&M. Before calling an API, grant the RAM user only the permissions required for your business needs. For more information, see Use RAM for access control.

Identity

Support status

Alibaba Cloud account

Supported

RAM user (recommended)

Supported

RAM role (recommended)

Supported

More information

Integration methods

Note

We recommend using an SDK to call APIs. SDKs provide the easiest integration and the best support.

Integration method

Support status

Alibaba Cloud SDK

Supported

Alibaba Cloud CLI

Not supported

Resource Orchestration Service (ROS)

Not supported

Terraform

Not supported

Custom API wrappers

Not supported

Alibaba Cloud SDK

  • Alibaba Cloud provides SDKs for various programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You can integrate an SDK to call APIs directly. SDKs simplify development by handling signing logic, timeouts, and retries, and by providing request and response objects for API operations. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.

  • You can use the Office Security Platform SDK to call its APIs. For information about the supported languages and dependency installation methods, see SASE SDK.

Alibaba Cloud CLI

  • Alibaba Cloud Command-Line Interface (CLI) allows you to use the aliyun command in a terminal to interact with Alibaba Cloud services and manage your cloud resources. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.

  • Not supported: You cannot use Alibaba Cloud CLI to call Office Security Platform.

Resource Orchestration Service (ROS)

  • Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies cloud resource management. You can write a template to define your required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine then automatically creates and configures all resources based on the template, enabling automated deployment and O&M. For more information, see What is ROS?.

  • Not supported: You cannot use ROS to manage Office Security Platform resources.

Terraform

  • Terraform is an open source tool that allows you to safely and efficiently preview, provision, and manage cloud infrastructure and resources. It operates similarly to ROS by transforming a template into API calls. For more information, see Terraform with Alibaba Cloud.

  • Not supported: You cannot use Terraform to manage Office Security Platform resources.

Custom API wrappers

Not supported: Custom API wrappers cannot be used to call Office Security Platform.

Usage notes

  • The queries per second (QPS) limit for an Alibaba Cloud account varies by API. For details, see the QPS limit described in each API reference.

    Note

    All RAM users under an Alibaba Cloud account share the QPS quota of that account.

  • You can save the RequestId returned from a call or the error message from an SDK and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service troubleshooting.