Overview

If you have a custom interface and homegrown content management systems, our comprehensive set of Application Programming Interfaces (APIs) enable you to develop an adapter to connect SwiftAssess with any LMS, CMS, VLE, or portal. So you can leverage the technology you have now to meet your unique needs.

With SwiftAssess API, instructors & administrators can easily schedule and deliver online assessments from within their existing CMS to access features that includes importing existing courses structures, questions data, students and assessments results, and more.

The API

This is the documentation for the SwiftAssess API. Read the contents of this page carefully, including the Terms of Use, to understand how to be a good API citizen and to understand general restrictions and concerns.

Your use and access to the API is expressly conditioned on your compliance with the policies, restrictions and other provisions related to the API set forth in our API Terms of Use and the other documentation we provide you. You must also comply with the restrictions set forth in the SwiftAssess Terms of Service and the SwiftAssess Privacy Policy, in all uses of the API. If SwiftAssess believes that you have or attempted to violate any term, condition or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.

Change Policy

SwiftAssess may modify the attributes and resources available to the API and our policies related to access and use of the API from time to time without advance notice. SwiftAssess will use commercially reasonable efforts to notify you of any modifications to the API or policies through notifications or posts on the SwiftAssess Online Portal. SwiftAssess also tracks deprecation of attributes of the API on its Changes Roadmap. Modification of the API may have an adverse effect on SwiftAssess Applications, including but not limited to changing the manner in which SwiftAssess Applications communicate with the API and display or transmit Your Data. SwiftAssess will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.

Security and Authentication

You must be a verified Account to make API requests. You can authorize against the API using your an API token. For more information about obtaining an API token, check out the Getting Started

Rate Limiting

This API is rate limited; we only allow a certain number of requests per minute. We reserve the right to adjust the rate limit for given endpoints in order to provide a high quality of service for all clients. As an API consumer, you should expect to be able to make at least 200 requests per minute.

If the rate limit is exceeded, SwiftAssess will respond with a HTTP 429 Too Many Requests response code and a body that details the reason for the rate limiter kicking in.

Headers

This is a JSON/XML API, depending on the Content-Type header on POST/GET Operations. You may get a text/plain response in case of error, e.g. in case of a bad request, you should treat this as an error you need to take action on.

Collections

Collections return a maximum of 100 records, and by default return 30 records. You can set this on a per request basis by passing e.g. per_page=50 in the request parameters.

Some collections can be ordered by transmitting a sort_order=desc or sort_order=asc parameter to the end point. Whether a specific collection can be ordered, is specified in the documentation for that specific resource.

We welcome all contributions. Please contact api@swiftassess.com for more feedback and suggestions.