How to retrieve an API Key and Organization ID from the Nash portal
portal.sandbox.usenash.com
). When you are ready for Production testing, please reach out to support@usenash.com to enable the API in Production.
Settings
page by clicking this option in the Nash’s Portal sidebar.
API
. This will redirect you to the API Settings and will contain all API Keys created by you.
Generate Key
.
key name
(mandatory) and description
(optional) to help you identify the API Key later. If you are registered in multiple organizations, you’ll have the chance to select which organizations you want to scope this Key with in the Selector. We will preselect the current organization to which you are logged in. Make sure to also add all features you want this Key to have access.
Adding a feature to a key does not guarantee the key’s access to that feature under the organizations you’ve selected. If you, the user, do not have access to that feature in a particular organization, then your key won’t be able to access it either, regardless of which permissions you have placed on the key.
Save
and your API Key will be created. Make sure to copy and store it because this will be the only time you’ll have access to view your key.
Confirmation Page
Org ID
. You will add this as a header param to every endpoint which interacts with an Organization’s resources, such as creating a job. For instance, you would need to add "Nash-Org-Id": "org_AbC123"
: to create a job within org_AbC123.
The "Nash-Org-Id"
header is an optional field for API keys that have access to multiple Nash organizations. If an API key is generated and it only has access to one Nash Organization, then there’s no need to include it in the request headers.
To retrieve that Org ID
, hover over the organizations in a key and copy it.