Authentication

Authentication Header

When you make a request to this API, you need to include a header called X-ApiKey with your API key as its value.

• This is how the system knows you are allowed to use the API.
• X-ApiKey is the name of the header you need to include in your API request.
• In header means you should put the API key in the header of your request.
• API key required for authentication explains that the API key is needed to verify your identity and give you access to the API.

Generate API Key

1. Navigate to Company Profile Page
   • Go to the company profile page in the Numarics app.
   • Locate the API keys section.
2. Initial State (No API Keys)
   • If API keys exist, a list of keys is displayed.
   • Click the button to add a new API key.
3. Existing API Keys
   • If API keys exist, a list of keys is displayed.
   • Click the button to add a new API key.
4. Generate API Key
   • A modal window will appear
   • Enter the API key name (required).
   • Optionally, enter the validity period.
   • Click Finish to generate the API key.
   • A new modal informs you that the API key has been generated.
5. Copy and Close
   • Copy the API key using the button provided.
   • Can be used also icon, or select+copy, as well.
   • Close the modal.
   • The API key is now listed in the API keys section.
6. Important Note
   • Once created, the API key cannot be recreated.
   • If the API key is lost, the user must generate a new one by repeating this process.
7. Deactivate API Key (if needed)
   • Click the action to deactivate an active API key.
   • Confirm deactivation in the modal that appears.