Here’s a step-by-step guide to enable and use APIs in your ContractWorks account, please speak to your Account Manager if you do not see this initially available for your room.
Instructions:
- Enable Access for a Specific User:
- Go to the Users section in Contractworks
- Find the specific user you want to grant API access to, click on their name.
- Next to API, enable the box to Authorize the User.
- Go to the Users section in Contractworks
- Verify Access:
- Log in as the user.
- Navigate to the Settings page.
- Check for the "API Settings" section, where you can manage API tokens.
- Generate and Use an API Key
- Go to the API Settings section under User Settings.
- Click Generate API Key
- *Important: The key will only be shown once. Copy and store it securely.
- Review the Securedocs API Documentation to find instructions and examples, in addition to the specific endpoints
- Use the API Key:
- Include the API key as a Bearer Token in the Authorization header for all API requests.
- Understand API Usage
- API Type: This is a GraphQL API, not a REST API.
- GraphQL allows precise queries and is widely adopted by platforms like Shopify and GitHub.
- Rate Limiting:
- 120 requests per hour per IP address.
Rate limits apply to all queries and mutations.
- 120 requests per hour per IP address.
- API Type: This is a GraphQL API, not a REST API.