What is an API?

API stands for “Application Programming Interface” and can be considered a back-end tool for particular use cases where you need to connect Dataverse to another platform. For Dataverse, you can request a token that utilizes the Dataverse API to connect to external services like the OSF open research collaboration platform. If you have expertise in command-line interfaces and need to direct upload large or numerous dataset files instead of using the standard webpage interface, you might take advantage of Dataverse’s “file upload” API. In the diagram below, we can see that while users can click a button within Dataverse’s web interface to upload a file, there are many other ways to get files into Dataverse, all using an API that allows for the uploading of files.

Open

The Dataverse API connects the repository to other tools to help you manage your dataset files.

APIs are helpful for system administrators and content managers who want to utilize Dataverse functionality, but you have to be familiar with programming and related technologies to take advantage of them. Most submitters and users will not need to use the API directly, but it is there if you need it.

For further information, see Dataverse's “What is an API?”

Setting up API Tokens

To utilize a data repository API, you must first create a personal API Token on your repository user account. Please see Using APIs in the Depository User Guide section for instructions on setting up API tokens.

API Terms of Use

The following terms and conditions govern all use of an Application Program Interface (API) to access and use the ASU Research Data Repository application and the services available on or at the ASU Research Data Repository application by you and any third parties who use your account.

This Terms of Use agreement governs and includes all APIs whose full or partial purpose is to provide access to the ASU Research Data Repository and its services and materials, including APIs offered by ASU Research Data Repository and third-party API applications created to access the Dataverse network from third-party websites (collectively referred to as “Dataverse API”).

Acceptance of Terms

Use of the Dataverse APIs is offered subject to acceptance of and compliance with all of the terms and conditions contained herein (the ASU Research Data Repository API Terms of Use), the Dataverse General Terms of Use (ASU Research Data Repository Terms of Use ), and all other applicable operating rules, policies and procedures of the ASU Research Data Repository application. By clicking “I accept” and/or by your use of the Dataverse APIs, you agree and accept all the terms in this agreement and all others mentioned above.

General Rules of Conduct

In using the Dataverse APIs, you represent that:

1. You have read and accepted ASU Research Data Repository’s General Terms of Use (ASU Research Data Repository Terms of Use );

2. You have read and understood the Site’s Privacy Policy (ASU Library Privacy Statement ), and you have read and understood the Site’s Community Norms (https://dataverse.org/best-practices/dataverse-community-norms ).

In accessing and downloading content from the ASU Research Data Repository using a Dataverse API, you acknowledge and agree that:

1. ASU Research Data Repository does not endorse, manage, oversee, control, take responsibility for, or make any representations or warranties for any Dataverse APIs, including third-party Dataverse API applications;

2. ASU Research Data Repository is not responsible for a) any User-uploaded content, format, Metadata, or lack thereof; b) representations or warranties made by the User about the User-uploaded content; and/or c) any limitations or restrictions placed on any User-uploaded content by the User, and will not be held liable with respect to the above (i) for any direct damages, or (ii) for any lost profits or special, indirect, incidental, punitive, or consequential damages of any kind whatsoever;

3. ASU Research Data Repository will not be liable or held responsible for any losses or damages to you, your affiliates/affiliated institutions, your service/API application, or anything else related to you, caused either in whole or in part by your access to and/or use of a Dataverse API application;

4. ASU Research Data Repository does not oversee, manage, or have any control over, and is therefore not responsible for, any content, services, materials, and information provided by the Dataverse API application;

5. ASU Research Data Repository makes no warranties and/or representations as to the timeliness, accuracy, completeness, reliability, correctness, availability, security, lack of defects/errors, lack of viruses/other harmful components, or overall quality of any content, materials, documents, files, and other information either uploaded or downloaded on ASU Research Data Repository by you or any third party; and

6. ASU Research Data Repository makes no warranties and/or representations as to the accuracy, completeness, correctness, availability, security, and overall quality of anything found on ASU Research Data Repository as accessed through the Dataverse API.

In using the Dataverse APIs, you shall not:

1. Attempt to conceal or otherwise misrepresent your identity or your application’s identity when using or requesting authorization to use the Dataverse APIs;

2. Use the Dataverse APIs in any manner or for any purpose that violates any law or regulation, any right of any person, including but not limited to intellectual property rights, rights of privacy, or rights of data use and distribution, etc.;

3. Use an unreasonable amount of bandwidth. ASU Research Data Repository reserves the right to decide what is unreasonable and may, at any time, restrict your access and use of the materials and services on ASU Research Data Repository through a Dataverse API if it deems your bandwidth use is unreasonable;

4. Use Dataverse APIs in a manner that may impair the functionality, stability, or operation of ASU Research Data Repository servers or adversely impact the behavior of other users or applications using the Dataverse APIs;

5. Use the Dataverse APIs for or in connection with any malicious programs or code including, but not limited to, adware or spyware;

6. Sell, lease, or sublicense datasets or other information found or downloaded from the Dataverse servers; and

7. Sell, lease, or sublicense Dataverse’s API application software, or access thereto or derive revenues, directly or indirectly, from the use or provision of Dataverse’s API application software.

Modification & Severability of Terms

ASU Research Data Repository reserves the right, at its sole discretion, to modify or replace any of the terms in this Agreement at any time without prior notice to Users. It is your responsibility to check the Agreement periodically for changes. Your continued use of the Service following the posting of any changes to the Agreement constitutes acceptance of those changes.

If any provision of the Terms of Use is found to be unenforceable or invalid, that provision will be limited or eliminated to the minimum extent necessary so that the Terms of Use will otherwise remain in full force and effect and enforceable.