OpenWater provides a mechanism for managing the entire program life cycle via API. You or your development team can create users, submit to programs, forward to rounds, assign judges, update fields, and pull data all via our REST api.
Single Sign On
If you are looking to build a single sign on (SSO), please see this article.
Authentication to the API
In order to authenticate to the API you must generate an API key. To do so go to System Settings > Permissions
The API operates under the privileges of an admin user, either create a user for API access or choose an existing user. Choose the API Keys option.
Add one or more API keys that tie to this user. If an API key is no longer needed or you believe it is compromised you should delete it.
REST API Access
The full API is available via our swagger specification.
You should connect to https://api.secure-platform.com
Use the header X-ClientKey as your OpenWater domain
(example: X-ClientKey: demo.secure-platform.com)
Use the X-ApiKey as your generated API key
(example: X-ApiKey: 00000000-0000-0000-0000-000000000000)
We will be releasing further how-to documentation and a NUGET package.
Fees and Rate Limits
All customer receive 10,000 API calls at no charge. APIs are limited to 2 per second and are metered as follows:
- Single API Call: 1 unit per call
- Report: 1 unit per second of report processing time
API limits can be increased in tiers (100,000, 500,000, 1MM+) and in speed (5 calls per second, 10 calls per second, 25+ calls per second)
Developer to Developer support is available in C#, Node JS and Python. Limited support also available for PHP.
Developer support is a premium service.