Help Center/ Partner Center/ API Reference/ API Invoking Methods/ API Access Permission (Partner)
Updated on 2024-08-27 GMT+08:00

API Access Permission (Partner)

API access requires authorization. You can attach roles that contain required permissions for accessing specific APIs to accounts as needed in Partner Center. Supported actions of APIs are listed in the following table. The API can be accessed as long as one of its actions is supported.

For APIs not listed in the table, fine-grained permission verification is not required and all operator accounts can access them.

Table 1

Scenario

Sub-Scenario

API Description

URL

Action

Path

Customer management

Customer registration

Verifying customer registration information

POST /v2/partners/sub-customers/users/check-identity

BPC_ITEM_SUBCUSTSERV_010118

Sales > Customers > Customer Management > Customer List > Create Partner Customer

Sending a verification code

POST /v2/bases/verificationcode/send

BPC_ITEM_SUBCUSTSERV_010118

Sales > Customers > Customer Management > Customer List > Create Partner Customer

Creating a customer

POST /v2/partners/sub-customers

BPC_ITEM_SUBCUSTSERV_010118

Sales > Customers > Customer Management > Customer List > Create Partner Customer

Real-name authentication

Requesting individual real-name authentication

POST /v2/customers/realname-auths/individual

BPC_ITEM_SUBCUSTSERV_010119

Sales > Customers > Customer Management > Customer List > Real-name Authentication Synchronization

Requesting enterprise real-name authentication

POST /v2/customers/realname-auths/enterprise

BPC_ITEM_SUBCUSTSERV_010119

Sales > Customers > Customer Management > Customer List > Real-name authentication synchronization

Requesting real-name re-authentication

PUT /v2/customers/realname-auths/enterprise

BPC_ITEM_SUBCUSTSERV_010119

Sales > Customers > Customer Management > Customer List > Real-name authentication synchronization

Querying the real-name authentication review result

GET /v2/customers/realname-auths/result

BPC_ITEM_SUBCUSTSERV_010119

Sales > Customers > Customer Management > Customer List > Real-name authentication synchronization

Customer management

Querying customers

POST /v2/partners/sub-customers/query

BPC_ITEM_SUBCUSTSERV_010100|BPC_ITEM_SUBCUSTSERV_010500

  • Sales > Customers > Customer Management > Customer List > View Customer List
  • Sales > Customers > Customer Management > Reseller Customers > View Customers

Freezing a customer account

POST /v2/partners/sub-customers/freeze

BPC_ITEM_SUBCUSTSERV_010501|BPC_ITEM_SUBCUSTSERV_010115

  • Sales > Customers > Customer Management > Reseller Customers > Freeze/Unfreeze Accounts
  • Sales > Customers > Customer Management > Customer List > Freeze/Unfreeze Accounts

Unfreezing a customer account

POST /v2/partners/sub-customers/unfreeze

BPC_ITEM_SUBCUSTSERV_010501|BPC_ITEM_SUBCUSTSERV_010115

  • Sales > Customers > Customer Management > Reseller Customers > Freeze/Unfreeze Accounts
  • Sales > Customers > Customer Management > Customer List > Freeze/Unfreeze Accounts

Reseller management

Querying resellers

Querying the list of resellers

POST /v2/partners/indirect-partners/query

BPC_ITEM_SALES_020100

Sales > Resellers > Reseller Management > My Resellers > View Resellers

Credit management

Managing credits

Querying balance

GET /v2/partners/credit/consumption-quota

BPC_ITEM_ACCOUNT_010500

Partner Information > Basic Information > Consumption Quota > View Quota

Transaction Management

Coupon management

Querying coupons

GET /v2/promotions/benefits/coupons

BPC_MENU_FINANCE_100100|BPC_ITEM_SUBCUSTSERV_050101

  • Partner Information > Basic Information > Consumption Quota > View Quota
  • Sales > Customers > Customer Orders > Order Payments > Pay for Orders

Yearly/monthly order management

Querying orders

GET /v2/orders/customer-orders

BPC_ITEM_SUBCUSTSERV_060100|BPC_ITEM_SUBCUSTSERV_060200

  • Sales > Customers > Customer Orders > Customer Orders > View Orders
  • Sales > Customers > Customer Orders > Reseller Customer Orders > View Orders

Querying order details

GET /v2/orders/customer-orders/details/{order_id}

BPC_ITEM_SUBCUSTSERV_060100|BPC_ITEM_SUBCUSTSERV_060200

  • Sales > Customers > Customer Orders > Customer Orders > View Orders
  • Sales > Customers > Customer Orders > Reseller Customer Orders > View Orders

Managing Pay-Per-Use Resources

Querying customer's pay-per-use resources

POST /v2/partners/sub-customers/on-demand-resources/query

BPC_ITEM_SUBCUSTSERV_010105

Sales > Customers > Customer Management > Customer List > View Customer Resources

Managing Customers' Budgets

Querying customer budget

GET /v2/partners/sub-customers/budget

BPC_ITEM_SUBCUSTSERV_010111|BPC_ITEM_SUBCUSTSERV_010503

  • Sales > Customers > Customer Management > Customer List > Adjust Credit Limit
  • Sales > Customers > Customer Management > Reseller Customers > Set Monthly Budgets

Batch querying customer budgets

POST /v2/partners/sub-customers/budget/query

BPC_ITEM_SUBCUSTSERV_010111|BPC_ITEM_SUBCUSTSERV_010503

  • Sales > Customers > Customer Management > Customer List > Adjust Credit Limit
  • Sales > Customers > Customer Management > Reseller Customers > Set Monthly Budgets

Setting customer budgets

POST /v2/partners/sub-customers/budget

BPC_ITEM_SUBCUSTSERV_010111|BPC_ITEM_SUBCUSTSERV_010503

  • Sales > Customers > Customer Management > Customer List > Adjust Credit Limit
  • Sales > Customer Business > Customer Management > Reseller Customers > Set Monthly Budgets

Bill Management

-

Querying monthly bills of a customer

GET /v2/bills/partner-bills/postpaid-bill-summary

BPC_ITEM_FINANCE_090100

Sales > Financial Information > Partner Bills > Partner Bill > View Partner Bill

Invoice Management

Invoice Management

Querying the invoice list

GET /v1.0/{domain_id}/payments/intl-invoices

BPC_ITEM_FINANCE_060100

Sales > Financial Information > Invoices > Invoice Center > View Invoice Requests