Developer guide

更新时间:
复制 MD 格式

Register a developer account on the Open Platform, subscribe to API products, and manage consumer credentials for API access.

Register a developer account

Register an account to access the developer portal and subscribe to API products. The Open Platform supports username-password registration and OIDC login.

Register with a username and password

Create a local developer account with a username and password.

  1. On the developer portal homepage, click Sign up in the login area.

  2. Enter your registration details, including username and password.

  3. Review your information and click Sign up.

Register using OIDC

If an administrator has configured OIDC login (such as enterprise SSO), log in with your enterprise account. The system creates a developer account on first login.

  1. On the developer portal homepage, click the OIDC login button (such as Log in with Alibaba Cloud).

  2. You are redirected to your enterprise Identity Provider (IdP) login page.

  3. Authenticate with your enterprise IdP.

  4. After authorization, the system redirects you to the Open Platform, creates your developer account, and logs you in.

Note

OIDC users do not need a password. The account is automatically approved after first login.

Registration approval

After you submit a password-based registration, activation depends on the portal's approval settings:

  • Automatic approval: Your account is activated immediately.

  • Manual approval: An administrator must approve your request before you can log in.

Important

OIDC users are automatically approved without administrator review.

Browse and subscribe to API products

After logging in, browse and subscribe to API products from the developer portal.

Browse products

  1. Log in to the developer portal.

  2. In the navigation bar, go to product pages such as Model, MCP, and Agent.

  3. Browse product names, descriptions, and categories. Use filters or search to find specific products.

  4. Click a product card to view its feature overview, user guide, and sample requests.

Subscribe to products

To subscribe to an API product, you need a consumer with a valid credential.

  1. On the product details page, click Subscribe.

  2. Select the consumer to use for calling this product.

    Note

    The system creates a default consumer upon registration. To create more, see Manage consumer credentials below.

  3. Click Confirm Subscription.

Activation depends on the portal's approval settings:

  • Automatic approval: The subscription is activated immediately.

  • Manual approval: An administrator must approve the request before you can call the APIs.

Manage consumer credentials

The Open Platform uses consumers as identity credentials for API calls. The system creates a default consumer upon registration.

Create a consumer

  1. Click your profile picture in the upper-right corner and select Consumer management.

  2. Click Add Consumer.

  3. Enter the consumer details:

    Parameter

    Description

    Consumer name

    The name to identify the consumer. Use a purpose-based name (for example, my-app-prod). Required.

    Description

    Purpose of the consumer (for example, "For production API calls"). Optional.

  4. Click Submit.

View and manage credentials

The system generates an API Key for each new consumer.

  1. In the consumer list, click View Credential to view the API Key.

  2. Copy the API Key and include it in request headers for authentication.

  3. To revoke a credential, click Delete. The credential is invalidated immediately.