File Sharing
In addition to API documentation, the Developer Portal also allows Providers to share important documents with Customers. These documents can include contracts, invoices, reports, etc. and can be shared in connection with an App or a specific API.
In addition, the Developer Portal offers automation features that can help streamline processes related to sharing and managing documents. For example, technical users can create workflows that automatically generate reports or invoices and distribute them to Customers.
Files & Folder
The Developer Portal allows Customers and Providers to exchange documents. The prerequisite for this is a connection via App.
Default Folder Structure
*File-Exchange
The admin of a Provider has the option of creating additional folders within the above-mentioned default folder structure and storing files in these folders. The admin of the Customer also has the option of storing files in the default folder structure; these files are then marked as "Customer Upload".
There are restrictions on which file types can be uploaded!
*Documentation-Files
The admin of a Provider has the option of storing files directly on the product. These files are used to document the API product and to provide additional resources for download.
| Documentation Files | Description |
|---|---|
| API-Explorer | Open-API format (SwaggerUI). Renders the uploaded Open-API file into the standard Swagger UI. |
| Readme | Markdown file format. This file is rendered directly in the product view. All H1 headings serve as navigation. |
| Other | All other files which are necessary for the documentation of the API. |
There are restrictions on which file types may be uploaded!