Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

An API (Application Programming Interface) is a back-end tool for special use cases where you need to connect a collection and datasets to other platforms. To utilize an API, you must first create a personal API Token on your repository user account. This page guides you through setting up and API for use in your collection or dataset records.

See the API Terms of Use in the Policy section of the user guide to learn what APIs are and how they can be used.

...

To create your API token, click on your account name in the navigation bar, then select “API Token” from the dropdown menu. In this tab, click “Create Token.”

...

Token Expirations

Remember, API Tokens Expire one year after creation. The date will be shown above your token. If you are using your token for a long-term connection, such as connecting to an OSF project, it's crucial to recreate the token at the time of expiration.

Tip

Tip: After creating your API token, set a calendar alert for the expiration date.

How to Recreate Your API Token

If your API Token becomes compromised or has expired, click on your account name in the navigation bar, then select “API Token” from the dropdown menu. In this tab, click “Recreate Token.”

Three square buttons Copy to Clipboard in a red box,  Recreate Token, and Revoke Token Image Added

Info

Additional Information about Dataverse Platform APIs and API Tokens

References ink to the official Harvard Dataverse documentation. Information is not specific to the ASU Research Data Repository.

Dataverse APIs are documented in the external API Guide, but the following sections may be of particular interest: