API Docs

1Data Gateway uses RESTful APIs which are publicly accessible and secured using tokens. See API Submissions for information on managing Submissions with the API.

Administrators can find a link to the Swagger docs via the Help and Support button in 1Data Gateway.

All users are able to access the APIs but Submission management and assignments are limited to the submission owner/creator.

All users can create submissions if it is part of their assignment and they have an API key.

All authenticated API endpoints require the client to provide an API token via HTTP Bearer authentication.

     Note: Unless noted, the API request and response bodies are in JSON format.

ClosedAPI Tokens

API Tokens are required on a per User basis and are necessary for authentication of the API endpoints.

All API tokens must be created individually but can be created by an administrator on behalf of Users or by the User themselves. The process is the same but is accessed from different pages.

Administrators can use the API Token tab of Users to create and manage API Keys on Users behalves.

Users can create and mange their own API Keys from the API Token tab when Managing Your Account.

     Note: The token becomes invalid if it passes the expiry date or the User's account becomes disabled.

     Note: For security purposes we recommend that tokens are carefully managed and only supplied to trusted individuals.

From the API Tokens tab click the Add icon to create a new API token.

API Tokens tab with an example token listed.

Fill in the name, description, and expiry date, and then click the Add API Token icon.

Add API Token popout requiring a name, description, and an expiration.

Copy the API token with the Copy button and click The Continue Button when you've stored the token somewhere safe.

An example generated API token, which warns to write it down as it cannot be viewed again.

API Tokens can be edited or removed:

Click the Edit button to edit and update the API settings.

API Token Settings popout allowing the token details to be edited.

Click the Remove button, then confirm with the Remove button to remove an API token.

Remove API Token popout, asking for removal confirmation.

ClosedAnalytics

The 1Data Gateway API can be leveraged to perform analytics in external applications.

The following API calls can be used for Specification reports on:

  • Rule conformance over time.

  • /api/v1/reports/specification/{specificationKey}/rule_conformance

  • Submissions over time.

  • /api/v1/reports/specification/{specificationKey}/submissions

  • Task performance over time.

  • /api/v1/reports/specification/{specificationKey}/task_conformance

    Replace the {specificationKey} with the Specification Key found in the Specifications.