Plans supporting API documentation
Professional | Business | Enterprise |
---|---|---|
The API documentation feature in Document360 provides a complete solution for creating and managing API references. This feature allows you to generate high-quality API documentation that helps users understand and work with your APIs effectively. You can generate this documentation by uploading the API specification file from a URL, a JSON/YAML file, or by integrating with a CI/CD flow.
Additionally, the Try it! feature in Document360 allows you to test API endpoints directly on the Knowledge base site. The interactive console in the Knowledge base site allows developers to input the necessary parameters and execute API calls, getting real-time responses. This feature is useful for troubleshooting and understanding how an API behaves without leaving the documentation or writing any code.
Authorization techniques
When interacting with an API, it is important to ensure that only authorized users can access certain data or perform specific actions. This is done using authorization techniques, which control access and permissions. Document360 supports various methods of authorization to secure your API, including:
Basic authentication: Requires a username and password passed in the the request.
Bearer token: UAuthenticates with a token generated after login.
API key: Uses a unique key, passed in the request headers, for authentication.
OAuth2: Secures APIs through various flows, such as Authorization code, PKCE, Client credentials and Implicit flows.
OpenID Connect: Extends OAuth2 by adding user identity verification.
Authorization considerations (OAuth2 and OpenID)
When working with APIs that use OAuth2 or OpenID for authorization, certain settings are essential for proper functionality.
Redirect URI: This is the URL that the user will be redirected to after completing an authorization flow. Ensure you set the URI in the format:
domain/oauth
. For example:https://apidocs.document360.com/oauth
.Silent renewal: Silent renewal automatically refreshes the authorization token in the background, so users don’t have to reauthenticate during their session. This keeps their session active without interruption. To prevent authorization from expiring during sessions where users interact with the Try It! feature, Document360 automatically renews the refresh token in the background. This ensures that users won’t need to reauthenticate manually.
Purchasing
You will have access to 1 API workspace as part of all Document360 paid plans (Professional, Business, and Enterprise). If you wish to purchase additional API workspaces,
Navigate to Settings > Knowledge base portal > Billing > My plan.
Click Purchase add-on.
Add the desired number of API documentation workspaces. Review the cost of the add-on and the amount due.
Click Confirm payment to proceed with the payment.
FAQs
What is an API reference?
An API reference is a documentation resource that provides comprehensive information about the functions, classes, methods, parameters, return types, and other components of an API. It is a guide or manual for developers who want to integrate or use the API in their applications.
How many API references can I create with Document360 API documentation?
Within each API workspace, you will be able to create a maximum of 3 API references.
The “Try it!” option is not available on the Knowledge base site. What could be the reason?
If the Try it! feature isn’t visible on the Knowledge base site, ensure that both the server variable and the URL are properly defined in your API specification file. Without these, the feature will not function.
What are the supported specification file formats?
You can upload your specification file as a URL, JSON, or YAML file. Document360 supports OpenAPI 2.0, OpenAPI 3.0, and Postman API specifications.
Related videos
Experience our modern API Documentation in Document360 like never before
Test API endpoints directly from Documentation with Try it feature
Additional information
Introducing API Documentation: Enhance your API Experience - Click to read