API Keys
The Smartbill API keys provide an easy and secure method to establish communication between your project and Smartbill. These keys are essential for authenticating requests and managing access to your data.
About Keys
Once you want to start generating API keys, you need to consider the following four aspects:
Business
This refers to the organization or branch for which the API will be operational. For example, if an organization has multiple locations, you will need to create an API key for each business.
Why is that? Each business has its own location, and when creating a document, it contains a property called control_number. This code is generated based on various factors, including the location ID.
Environment
When creating an API key, you can choose its environment. This allows you to create one key for Testing and another for Production.
Keep in mind that you can change the environment of the API key anytime you need.
Roles
You can assign a role to the API key to manage different levels of access. You can choose between manager and transmitter roles. The key difference is that the transmitter role cannot invalidate documents.
Security
Once you have generated your API keys, ensure that you keep them in a safe place. Do not expose these keys in public repositories or anywhere they might be accessed by unauthorized users.
Once you generate an API key, this is the only point at which you will be able to see the private key.
How to generate?
Generating an API key in Smartbill is a straightforward process. Follow these steps:
1. Access the Smartbill Dashboard
First, log in to your Smartbill dashboard. On the dashboard, look for the option that says “Manage API Keys.”
2. API Keys Screen
Once you click on “Manage API Keys,” you will be taken to the API Keys screen. Here, you will see a table where you can manage your API keys. You can delete or change the environment of existing keys. You will also see a button labeled “Create API Key.”
3. Creating the API Key
After clicking the “Create API Key” button, a prompt will appear asking you to provide the following details:
- Select the Business: Choose the organization or branch for which you are generating the API key.
- Name for the API Key: Enter a name that will help you identify this key later.
- Environment: Select whether this key is for testing or production.
- Role: Choose between manager and transmitter roles.
4. Finalizing the API Key
Once you fill out all the required information, you will see your newly generated API key. Make sure to keep your keys in a safe place, as this is crucial for maintaining the security of your integration with Smartbill.
