API Key Generation: This tool lets users create new API keys whenever necessary. It's important for keeping access to the system safe and managed, making sure every key is one-of-a-kind and works correctly for its intended use.

Expiration Date Setting: Users have the option to set an expiration date for each key, with a maximum limit of one year from the current date. This is important for safety and control because it stops keys from being active forever.

Editing Capabilities for Existing Keys: This functionality includes the ability to adjust the expiration dates and add or modify notes for existing API keys. Upon receiving the 60-day pre-expiration notice, you can extend the key's validity by up to two months beyond the original expiry date, but this adjustment can only be made once.

API Key Deletion: The system offers the capability to delete API keys as necessary. This feature is important for maintaining a clean and secure environment, allowing users to remove access when it is no longer needed or when security concerns arise.

Navigate to Admin > Logins and Permissions > User Groups. The "System Administrator" role is designed with admin module permissions by default. However, should you require modifications to other groups, you can manage these adjustments using the provided list.

Navigate to Admin > Logins and Permissions > API Access Admin (Beta). Click the green "Create API Key" button.

Select from the dropdown which APIs the key will have access to (single or multiple).

Note: To modify the accessible APIs for a key, delete the current key and create a new one. Update your integration with this new key.

Pick the expiration date for the key.

Note: Keys can have an expiration date set within a year of creation, with options for a two-month extension and automatic reminders. Unrenewed keys are deleted 30 days after expiration.

Add a note to provide additional context about the key. Include a note with each key for extra context, useful for businesses with many locations.

💡Tip: Some organizations use the notes section to list any associated camps.

Important Considerations:

Once the API key is created, it will be displayed for you to copy it. This is the only time this key will be visible.

Click the green "OK" button to create your API key.

Click "Create Subscription Keys". This will generate the subscription keys for your camp.

Click on "Show" to view the subscription key. You have the option to toggle between 'show' and 'hide' to either display or conceal the key.

Note: You'll be equipped with both a primary and a secondary key. This setup ensures that during times of regeneration or security updates of the primary key, you can effortlessly transition to utilizing the secondary key for continuous service.

Click on the blue “Documentation Login” link.

Enter the API key that you created in the "API Access Admin" Page.

Once you are authenticated, you will be able to access all the API documentation from the documentation landing page.

To begin making API calls, you must first obtain an Authorization token. Navigate to the "Endpoints'' section and select the "Get JWT With ApiKey" endpoint. In this section, input your API key and Subscription key to receive the necessary token.

In this section, input your API key and Subscription key to receive the necessary token.

After receiving the token, you can make calls to all the APIs that the key has access to. API tokens are active for 1 hour.

Navigate to Admin > Logins and Permissions > API Access Admin (Beta). Select the green "Create API Key" button from the top right.

From the API menu, select the "Financial" (Along with any other APIs) and click the green "Save" button.

Note: If you want to use just one key for all your integrations, you might need to update your current setup to include the new key. Or, if you're mainly interested in financial endpoints, you can create a new key just for those services.

How can I access data for all the camps in our group?

If you are an enterprise camp, you will see a list of all your camps when generating an API key. You have the ability to select which camps’ data you want the key to access.

What should I do if a camp is no longer part of our group and I need to revoke their API access?

API keys cannot be altered once created. To revoke access, you will need to delete the existing key, generate a new one, and then update your integration accordingly.

How do I update my API access if a new camp is added to our group?

Since API keys are immutable, you will need to delete the current key and create a new one to include access for the new client. Remember to update your integration with the new key.

What steps should I take if a new API is added and I want to access it?

Similar to other scenarios, because API keys are immutable, you must delete your existing key and generate a new one to modify permissions for the new API. Ensure your integration is updated with this new key.

I received my API keys before the Admin portal was launched. Can you clarify the expiration date, notification process, and any changes to my permissions?