API FAQs 2022.pdf
ASQ Online API Frequently Asked Questions
1. What is ASQ® Online API?
ASQ Online API (Application Programming Interface) allows ASQ Online to “connect” with another database management system or application. It is an automated way to import and export child data between an ASQ Online account and an external customer database management system.
2. What information can be automatically exported from ASQ Online into my data management system or application?
The ASQ Online allows the following information to be automatically exported into a data management system or application: Child Profile data including custom fields; Caregiver Profile data including custom fields; Screening data associated with the Child Profile; the screening data includes the questionnaire item responses, parent comments, the questionnaire scores, and the questionnaire cutoff scores.
You can use the API to transmit new data or update existing data.
3. What information can be automatically imported from my data management system into ASQ Online?
The following information can be automatically imported into ASQ Online from your data management system or application via the API: Child Profile data including custom fields; Caregiver Profile data including custom fields; Screening data associated with the Child Profile; the screening data includes the questionnaire item responses, parent comments, the questionnaire scores, and the questionnaire cutoff scores.
You can use the API to transmit new data or update existing data.
4. What is the pricing for ASQ Online API?
ASQ Online API is an annual subscription based on annual screening usage.
| Annual Screening Usage* | Annual Subscription Fee | |
|---|---|---|
| Tier 1 | 1-200 | $150 |
| Tier 2 | 201-500 | $300 |
| Tier 3 | 501-1,000 | $550 |
| Tier 4 | 1,001-2,000 | $800 |
| Higher tiers | More than 2,000 | Contact for pricing |
*Annual Screening Usage represents the number of screens finalized in ASQ Online during the subscription period.
5. What information do I need to get started with API?
See below for the steps that you need to take as a customer and what your developer or IT staff will need in order to develop the “connection” between your management system or application and ASQ Online using the API.
| Customer | 1. You must have either an ASQ Pro or Enterprise subscription. 2. You must purchase the API add-on subscription. 3. Within ASQ Online, you will need to generate API tokens and enter the name and email of the developer who will be developing the interface to ASQ Online. An API token can be generated for one or more programs or your entire ASQ Online account.
- Set up your Access Control for the API: Read, Create, and Update. This will inform which data will be accessible through the API. | | --- | --- | | Your Developer or IT Staff | 5. Provide your developers or IT staff with the API tokens and the API documentation needed to develop the interface with ASQ Online. The API documentation is available as a Quick Link from your Account page. |
The type of access controls are defined as follows:
| Read | Read-Only information from database on information that currently exists (e.g., List of caregiver profiles, List of screenings for a child) |
|---|---|
| Create | Create or add new data into ASQ Online (e.g., create a new child profile, create a new screening for a child) |
| Update | Update information for an existing child or caregiver profile (e.g., update existing child profile) |
6. What programming code is required to use the ASQ Online API?
The ASQ Online API was developed using JSON (JavaScript Object Notation). The data interchange is language independent and can be used with any programming language to transmit data between a server and web application.
7. What type of documentation is available for my developers?
The API documentation contains all the necessary information needed for a developer to develop a connection or bridge with ASQ Online. The documentation includes the following: Parameters, Request Headers, Response Headers, and API commands. Click the following link to view the API Documentation: https://www.asqonline.com/api/docs
8. When will the data transfer occur between ASQ Online and my data management system?
You have the ability to set the frequency of the transfer of data—once a day, once a week, etc. The maximum frequency for data transfer is once a day. You also have the ability to set the desired time for the transfer (e.g., 12:00 a.m. ET).