The primary goal of this topic is to help you understand what the default folder is, and what you can expect from it. Every organization account has a default folder, including yours. Therefore, it’s of essence to know its purpose and how it could affect your security.
- You understand what folders are
- You are aware of folders their privacy and public settings
- You understand the meaning of user roles
Read more about
- Folders and their settings
- User roles (coming soon).
Whenever you generate a document in Inkit Render, it is automatically placed in a folder. The folder where your document is placed depends on whether or not you included a folder ID in your HTML request.
For example, let’s say you decide to have all invoices you generate in the US be placed in your ‘Invoices_US’ folder. You would ensure all systems which integrate with the API would include that specific folder ID in their requests, and you would be set.
However, if you have not created any folders yet, it is impossible to specify a folder ID.
The default folder is the solution to this problem. It allows you to create renders without specifying a folder ID. Meaning you could sign in to the Inkit platform and generate a document without any setup right now.
To render documents without folders is useful for first-time users who have not organized or categorized their data yet. But also for those who want to do a few quick test runs.
Note: Knowing about default folder placement is helpful if you are unsure whether or not you have sent an ambiguous request. Perhaps you believed your request included a folder ID, but somehow you can’t seem to find where the document is. It could happen, even while you received a 200 successful request response code. In such cases, it would be wise to take a look at the default folder.
To conclude, the default folder is where your documents get put when you don’t include a folder ID, whether you have zero, one, or many of them.
- Want to send your first request to the Inkit Render API? Check out the Integration Quickstart Guide
While using the default folder for rendering documents is convenient, you may wish to reconsider doing so at scale. Even while you are perfectly able to do so, we do not recommend you to.
The problem with the default folder is that any user or system within your organization can access its contents. It is a public folder, and you cannot customize its data access.
You absolutely should not put any generated confidential documents or private data in the default folder. Please conform to test-driven development principles. Ensure your systems include folder IDs in their requests.
We highly recommend you use folders, their public and private settings, and their flexible authorization customizability.
Avoid unauthorized users from accessing any data they should not.
Updated 23 days ago