Tavio Public API
6 min
the tavio platform's public api for the tavio hub allows partners to easily embed environment creation and solutiond deployment functionality directly into a vendor's application, making the integration 100% seamless for the end user you may build your own custom interfaces for this api, or use our tavio smart connector within on platform workflows, to combine multiple api calls into a single request to perform complex functions with robust error checking example in a single validated workflow, you can create a new customer, add users, configure a solution, and execute the final deployment api authentication our api uses a hierarchical three token system to manage access for users and automated services 1\ user access tokens these tokens are used for authentication by individuals or applications acting on their behalf organization authentication token (orgauth) the initial user token, obtained by authenticating with a username and password at /v1/{orgdomain}/auth/login it grants permissions based on the user's role across the entire organization environment authentication token (envauth) an environment specific token obtained via /v1/{orgdomain}/environments/{envdomain}/connect it requires the orgauth as a bearer token and allows actions within a specific customer environment note both orgauth and envauth tokens can be renewed by calling /v1/{orgdomain}/auth/token/renew 2\ organization admin token (orgadminoauth) this token is for trusted automated services or backend systems obtained via the oauth 2 0 client credentials flow , it grants full administrative access to the organization to generate a client id and secret access the my organization management page navigate to the oauth clients tab click the generate button select the api organization admin scope and the client credentials grant type customer and user management gain full control over managing customer environments and users within your organization environments create, list, retrieve, update, and delete customer environments users add new users, list current members, and manage account details access control manage granular permissions at both the organization level (admin/owner) and environment level (developer/support) solution and configuration management the api is centered around predefined "solutions," which serve as templates for integrations list solutions browse and view details of all available solutions manage configurations create and update specific settings (credentials, unique data) required for a solution to function for a specific customer deployments deployments are the core operational component where you activate a solution for a customer create deployments activate a solution by selecting a template and providing the required configurations manage deployments list, view, or update existing deployments control status programmatically enable (deploy) or disable (undeploy) an integration as needed