1Data Gateway uses RESTful APIs which are publicly accessible and secured using keys. See API Submissions for information on managing Submissions with the API.
The API is documented using the OpenAPI standard and is available via the Help and Support page in 1Data Gateway to Users with the User Manager Role.
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 Key via HTTP Bearer authentication.
Note:Unless noted, the API request and response bodies are in JSON format.
API Keys are required on a per User basis and are necessary for authentication of the API endpoints.
API Keys cannot be created in bulk but Users can generate personal API Keys themselves or Users with the User Manager Role can create them on their behalf. The process is the same but is accessed from different pages.
Users with the User Manager Role can use the API Key tab of Users to create and manage API Keys on Users behalves.
Users can create and mange their own API Keys from the API Key tab in My Account.
Note:The key becomes invalid if it passes the expiry date or the User's account becomes disabled.
Note:When Keys are within 7 days of the expiry date, the User will receive daily notification emails until the key has expired, been removed, or had the expiry date extended.
Note:For security purposes we recommend that keys are carefully managed and only supplied to trusted individuals.
From the API keys tab click the Add button to create a new API Key.
Fill in the name, description, and expiry date, and then click the Add API Key button.
Copy the API key with the Copy button and click Continue when you've stored the key somewhere safe.
API Keys can be edited or removed:
Click the Edit button to edit and update the API settings.
Click the Remove button , then confirm with Remove to remove an API Key.
API Keys
to create a new API Key.
and click Continue when you've stored the key somewhere safe.
to edit and update the API settings.
, then confirm with Remove to remove an API Key.
