The API key will lose authorization when the session expires, e.g., when you sign out via the browser or the server automatically times out your session.
Configure Session Keys
- Select (Admin) > Site > Admin Console.
- Click the Admin Console Links tab.
- Under Configuration, click Site Settings.
- Under Configure Security, check the box for Allow API session keys.
Access and Use a Session Key
Once enabled, the user can log in, providing all the necessary compliance information, then retrieve their unique session key from the username pulldown menu:
The session ID is a long, randomly generated token that is valid for only this single browser session. Click Copy to Clipboard
to grab it. Then click Done
You can then paste this key into a script or other API access of data. Your use of the data will be logged with all the same data access information you provided when you logged in.
For example, if you were accessing data via R, you could run the following command in your R interface to enable access to the protected data.
You will then be able to access the data from R until the session associated with that key is terminated, whether via timeout or log out.