Availability: OCC and ECM Enterprise License Tiers. Not available for Individual or Single User Licenses
Enablement: License Admins
The Proxima API is a new feature that allows the generation of API keys for Proxima projects. API keys allow users to export key raw data from specific Proxima projects to third party applications that support importing JSON data over a secured API endpoint. This can be useful in creating visuals of the data in tools such as Tableau or PowerBI.
License Admin Enablement
The Proxima API is available to License Holders and Enterprise Teams with access to Proxima and must be enabled by the License Admin for each Proxima user with projects that they want exposed via the API.
OCC and ECM License Tiers:
In the License Admin Center:
Navigate to the Apps section
Find Proxima, ensure it is enabled for the user and click Enable External API
Note: The [Enable External API] option will only show if Proxima is enabled for the user.
Integrate and Equip License Tier:
In the License Admin Center:
Navigate to the Apps section
Find Integrate & Equip
Click Enable External API
Once enabled, the user will see the API Management feature under the Project Settings page of their Proxima project. Guidance on Generating API Keys can be found below.
Additional Documentation:
Generating an API Key in Proxima
Once the Proxima API has been enabled for the user, they can start gathering the API key for the projects they wish to integrate. Follow the instructions below to obtain an API key:
Log into Proxima
From the landing page, select a Project and navigate to the Project Settings section.
Under Details, you will find a section labeled "API Management" Please note, the feature will only show for Project Owners or Administrator collaboration levels.
To generate an API key, click on the "Generate API Key" button.
Once generated, the API key will be immediately shown on your screen. It is important to copy and paste the API key right away because it will not be visible if you navigate away from the page and return later.
If necessary, you can revoke the API key by clicking on the "Revoke API key" button. This will allow you to generate a new key.
Frequently Asked Questions
At a high-level, what is API and how does it work?
An API (Application Programming Interface) serves as a connection between different software applications, allowing them to communicate and share information seamlessly. It acts like a bridge, enabling different tools to work together and exchange data smoothly.
The Proxima API is a 'read-only' API that can be used on third party applications that support importing JSON data over an API endpoint.
Do my API Key expires?
No, your API key is evergreen. Please note - the key is only retrievable when you first generate it, so be sure to copy it and save in a secure place like a password vault.
Can I generate API keys for all projects at once?
Currently, it is not possible to generate API keys for multiple projects simultaneously; API keys must be generated individually for each project.
What kind of support does Prosci offer?
The Prosci Product Team is available to assist you with any issues related to the API. If you encounter bugs in the API responses or experience any downtime, our dedicated team will promptly address your concerns and provide the necessary support.
However, we can not provide support for third-party applications that the API Keys are used with.