Avaza Documentation API

About this Cloud Hub Solution:

‍

The Avaza Documentation API is a powerful tool that allows developers to create, update, and delete documentation templates and content. It also enables the retrieval and rendering of documentation templates in various formats, such as PDF and HTML.

In addition, the API facilitates the management of documentation versions and revisions, making it easy to track changes and updates.

Developers can also use the API to integrate Avaza documentation with other applications and platforms, streamlining workflows and enhancing productivity.

‍

API Security & Authentication

To ensure secure access, the API provides multiple authentication options, including OAuth2 Implicit and Authorization Code flows, as well as Personal Access Token.

All connections should be encrypted over SSL/TLS to protect sensitive data.

You can manage your API authentication credentials within your Avaza account, but this requires Administrator permissions.

‍

OAuth2 Authorization endpoint

The API provides the following OAuth2 endpoints:

• OAuth2 Token endpoint
• URL for subsequent API Requests
• Blogpost about authenticating with Avaza's API
• Blogpost on using Avaza's webhooks

Please note that the OAuth flow currently issues Access Tokens that are valid for 1 day and Refresh tokens that last for 180 days.

The API respects the security Roles assigned to the authenticating Avaza user and filters the data returned accordingly.

‍

Support

If you need assistance with the API or would like to request access, please contact the Avaza Support Team via support chat.

‍

User Contributed Libraries

Some users have kindly contributed libraries to help with API integration.

However, please be aware that these libraries have not been tested or endorsed by Avaza, and you should review them carefully before using them at your own risk.

‍

‍