API Key and Org ID
How to retrieve an API Key and Organization ID from the Nash portal
RESTful API
The API follows modern RESTful conventions and speaks JSON in both directions. As the API uses JSON for both requests and responses, we will assume that requests with a payload are using properly formatted JSON, however, we still recommend setting the Content-Type header to the value application/json.
API protocols and headers
The Nash API uses POST requests to communicate and HTTP response codes to indicate status and errors.
Every Nash API response includes a job_id as the ‘X-Job-Id’ header. The request_id is included regardless of whether or not the API request succeeded or failed. For faster support, include the request_id when contacting support regarding a specific API call.
All requests are strictly HTTPS
Enabling your API access
Your organization’s API will be enabled in Sandbox automatically (portal.sandbox.usenash.com). When you are ready for Production testing, please reach out to support@usenash.com to enable the API in Production.
Generating your API Key directly from Nash’s Portal
Go to your Settings page by clicking this option in the Nash’s Portal sidebar.
Select API. This will redirect you to the API Settings and will contain all API Keys created by you.
Once you are there, click on Generate Key.
Add a 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.
After you’re done, click 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.
Retrieving and Using an Organization ID
Now that you created your API Key, you’ll need the id for the Organization you wanna read/write information from. We call this 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.