Developer docs groups APIs by managed object and describes parameters, responses, and required permissions.
Developer docs groups APIs by managed object and describes parameters, responses, and required permissions. Administrators can use it to determine application permissions and perform a read-only test.
For VPC deployments, Developer docs is separately deployed within the enterprise's VPC, uses an enterprise-specific domain such as
Record the request time, path, status, and error response. Remove the Authorization header and other secrets before sharing diagnostic material. Correct parameters according to their field requirements and check permission errors in App authorizations. Evaluate success from the response and target data, not merely from having sent the request.
Return to: Open Platform overview
xxx.vpc.qwenwork.cn, and is accessible without sign-in. Use the actual documentation address provided by your deployment; the international console opens its corresponding Developer docs entry.
Find an API
- Open Open & Integration → Open Platform → Developer docs.
- Browse categories or search for an object and action, such as users, departments, query, or create.
- Check the method, path, and permissions first, then review parameters and response examples.
- Compare the required permissions with the application's configuration in App authorizations.
Make the first call
- Create and enable an enterprise application and grant the needed read-only permissions.
- Generate an API Key and store it in the calling service's environment.
- Use the enterprise's actual service address. Follow the API example for
Authorization: Bearer <API_KEY>, query parameters, and request body. - Send the query and verify the HTTP status and returned data belong to the intended enterprise.