New article
Recently updated
Understanding the API feature
Who is this article for?
Administrators and developers who want to understand the Web Services API and how to integrate with Quality Management.
Application server access is not required for hosted customers. You need your Web Services URL and a Quality Management user account.
This article explains how the Quality Management Web Services API works, what it includes and how to start using it.
1. Understanding the API
- The Web Services API (QPulse5WebServices) lets other systems read and create Quality Management records, such as documents, audits, occurrences and non-conformances.
- The Quality Management mobile app uses the same API, so it is available in your hosted environment alongside your Web and Desktop clients.
- Ideagen hosts and maintains the API as part of your hosted service. You don't need any additional infrastructure on your side.
To get started, you can use:
- Your Web Services URL, shown on your service report, and live WSDL documentation for each service.
- The Quality Management Web Service APIs Technical Reference Guide, available from Ideagen Support on request.
2. Features included with the API
| Feature | Description |
|---|---|
| Endpoint formats | SOAP, REST and JSON endpoints for each supported service |
| Authentication options | Quality Management username and password (Authenticate), or a single sign-on access token (AuthenticateSSO). Both return a token to use in later calls. |
| Live service metadata | WSDL available for each service by adding ?wsdl to the service address |
| Developer resources | Technical Reference Guide. Endpoints can be tested with tools such as SoapUI. |
3. Security and access note
- All endpoints use HTTPS, and every call needs a valid authentication token.
- Use a dedicated integration account that has only the permissions your integration needs.
- Authentication tokens are generated using the server's PublicTokenKey, which Ideagen manages in hosted environments. If this key is changed, existing tokens stop working.
4. Supported modules and endpoints
| Module | Example operations |
|---|---|
| Core | Authenticate, AuthenticateSSO, GetServerInfo, GetUsers, UpsertPerson |
| Documents | GetDocument, CreateNewDocument, AcknowledgeDocument |
| Audits | GetAudit, CreateNewAudit |
| Occurrences | CreateNewOccurrence, GetOccurrence |
| Incidents | GetIncident |
| Non-conformance | GetNonConformances, CreateNewNonConformance |
| Training | GetCourses, AddCompletedEvent |
| Customers, Suppliers and Assets | Available through their own services. See each service's WSDL for operations. |