Skip to content

intro.rst

Latest commit

 

History

History
executable file
·
247 lines (163 loc) · 10.3 KB

intro.rst

File metadata and controls

executable file
·
247 lines (163 loc) · 10.3 KB

Introduction

The Dataverse Software APIs allow users to accomplish many tasks such as...

  • creating datasets
  • uploading files
  • publishing datasets
  • and much, much more

... all without using the Dataverse installation's web interface.

APIs open the door for integrations between the Dataverse Software and other software. For a list, see the :doc:`/admin/integrations` section of the Admin Guide.

|toctitle|

What is an API?

API stands for "Application Programming Interface" and an example is the Dataverse Software's "file upload" API. In the diagram below, we can see that while users can click a button within Dataverse installation's web interface to upload a file, there are many other ways to get files into a Dataverse installation, all using an API that allows for uploading of files.

.. graphviz::

  digraph {
    //rankdir="LR";
    node [fontsize=10]

      browser [label="Web Browser"]
      terminal [label="Terminal"]

      osf [label="OSF",shape=box]
      ojs [label="OJS",shape=box]
      rspace [label="RSpace",shape=box]
      uploader [label="DvUploader"]
      script [label="Script\n(Python,\nR, etc.)"]

      addfilebutton [label="Add File GUI"]
      addfileapi [label="Add File API"]
      storage [label="Storage",shape=box3d]

      terminal -> script
      terminal -> uploader

      browser -> ojs
      browser -> osf
      browser -> rspace
      browser -> addfilebutton

      uploader -> addfileapi
      ojs -> addfileapi
      osf -> addfileapi
      rspace -> addfileapi
      script -> addfileapi

      subgraph cluster_dataverse {
        label="Dataverse"
        labeljust="r"
        labelloc="b"
        addfilebutton -> storage
        addfileapi -> storage
      }
  }

The components above that use the "file" upload API are:

  • DvUploader is terminal-based application for uploading files that is described in the :doc:`/user/dataset-management` section of the User Guide.
  • OJS, OSF, and RSpace are all web applications that can integrate with a Dataverse installation and are described in "Getting Data In" in the :doc:`/admin/integrations` section of the Admin Guide.
  • The script in the diagram can be as simple as a single line of code that is run in a terminal. You can copy and paste "one-liners" like this from the guide. See the :doc:`getting-started` section for examples using a tool called "curl".

The diagram above shows only a few examples of software using a specific API but many more APIs are available.

Types of Dataverse Software API Users

This guide is intended to serve multiple audiences but pointers various sections of the guide are provided below based on the type of API user you are.

API Users Within a Single Dataverse Installation

Each Dataverse installation will have its own groups of people interested in APIs.

Users of Integrations and Apps

Integrations and apps can take many forms but two examples are:

  • Using Open Science Framework (OSF), a web application, to deposit and publish data into a Dataverse installation.
  • Using DVUploader, a terminal-based desktop application, to upload files into a Dataverse installation.

In both examples, users need to obtain an API Token to authenticate with a Dataverse installation.

Starting point   A good starting point is "API Tokens" in the :doc:`/user/account` section of the User Guide. DvUploader is documented in the :doc:`/user/dataset-management` section of the User Guide. The integrations that are enabled depend on your Dataverse installation. You can find a list in the :doc:`/admin/integrations` section of the Admin Guide.

Power Users

Power users may be researchers or curators who are comfortable with automating parts of their workflow by writing Python code or similar.

Starting point   The recommended starting point for power users is the :doc:`getting-started` section.

Support Teams and Superusers

Support teams that answer questions about their Dataverse installation should familiarize themselves with the :doc:`getting-started` section to get a sense of common tasks that researchers and curators might be trying to accomplish by using Dataverse Software APIs.

Superusers of a Dataverse installation have access a superuser dashboard described in the :doc:`/admin/dashboard` section of the Admin Guide but some operations can only be done via API.

Starting point   A good starting point for both groups is the :doc:`getting-started` section of this guide followed by the :doc:`/admin/troubleshooting` section of the Admin Guide.

Sysadmins

Sysadmins often write scripts to automate tasks and Dataverse Software APIs make this possible. Sysadmins have control over the server that the Dataverse installation is running on and may be called upon to execute API commands that are limited to "localhost" (the server itself) for security reasons.

Starting point   A good starting point for sysadmins is "Blocking API Endpoints" in the :doc:`/installation/config` section of the Installation Guide, followed by the :doc:`getting-started` section of this guide, followed by the :doc:`/admin/troubleshooting` section of the Admin Guide.

In House Developers

Some organizations that run a Dataverse installation employ developers who are tasked with using the Dataverse installation's APIs to accomplish specific tasks such as building custom integrations with in house systems or creating reports specific to the organization's needs.

Starting point   A good starting point for in house developers is the :doc:`getting-started` section.

API Users Across the Dataverse Project

The Dataverse Project loves contributors! Depending on your interests and skills, you might fall into one or more of the groups below.

Developers of Integrations, External Tools, and Apps

One of the primary purposes for Dataverse Software APIs in the first place is to enable integrations with third party software. Integrations are listed in the following places:

Starting point   Good starting points are the three sections above to get a sense of third-party software that already integrates with the Dataverse Software, followed by the :doc:`getting-started` section.

Developers of Dataverse Software API Client Libraries

A client library helps developers using a specific programming language such as Python, Javascript, R, or Java interact with Dataverse Software APIs in a manner that is idiomatic for their language. For example, a Python programmer may want to

Starting point   A good starting point is the :doc:`client-libraries` section, followed by the :doc:`getting-started` section.

Developers of The Dataverse Software Itself

Developers working on the Dataverse Software itself use the APIs when adding features, fixing bugs, and testing those features and bug fixes.

Starting point   A good starting point is the :doc:`/developers/testing` section of the Developer Guide.

How This Guide is Organized

Getting Started

See :doc:`getting-started`

API Tokens and Authentication

See :doc:`auth`.

Lists of Dataverse APIs

Please note that some APIs are only documented in other guides that are more suited to their audience:

Client Libraries

See :doc:`client-libraries` for how to use Dataverse Software APIs from Python, R, Java, and Javascript.

Examples

:doc:`apps` links to example open source code you can study. :doc:`getting-started` also has many examples.

Frequently Asked Questions

See :doc:`faq`.

Getting Help

Dataverse Software API questions are on topic in all the usual places:

After your question has been answered, you are welcome to help improve the :doc:`faq` section of this guide.
⚡