2022-12-07: Updated to incorporate cdiscID, SSO solution for CDISC applications
2020-10-12: Initial version
Important note about API key
Accessing CDISC Library API without an API key will result in HTTP 401 (Access Denied). A message similar to the following will appear in the response payload:
{ "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." }
General Process Flow
Obtain API Key
UPDATED
# | Instruction | Screenshot | Remarks |
---|---|---|---|
1 | Obtain a cdiscID, a single sign-on solution for CDISC applications | For details, refer to cdiscID: Sign in/Sign up Instructions. | No actions are needed for existing CDISC Library users. |
2 | Navigate web browser to the API Management Developer Portal at https://api.developer.library.cdisc.org/signin. | Users can alternatively access the API Management Developer Portal through the Data Standards Browser's gear icon. | |
3 | Enter same credentials as you would for CDISC Library Data Standards Browser. Click Sign In. | Enter the same credentials you would for Data Standards Browser. Use the Forgot your password? link to reset password. | |
4 | Select API Key from top navigation menu. | ||
5 | Verify CDISC Library API is listed as a product under the Subscription section. | ||
6 | Click "Show" (of either primary or secondary key) to reveal a system-generated API key assigned to your CDISC Library account. | An API key is a 32-byte hexadecimal value. A fictitious key looks like this: abcdef0123456789abcdef0123456789 . |
Test API Endpoint with API Subscription Key
Instruction | Screenshot | Remarks | |
---|---|---|---|
1 | Compose an CDISC Library API query to this specification:
| Specifying the Accept header is optional. | |
2 | Execute query. | HTTP 200 is expected when authentication is successful. | |
3 | Obtain API usage metrics from https://api.developer.library.cdisc.org/reports. |