New article
Recently updated
Understanding the licensed API feature
Who is this article for?
Users who want to understand the licensed feature overview.
Application server access is required.
This article explains how the licensed API feature works and what is included when it is enabled.
1. Understanding why the API is licensed separately
- Provides enterprise-grade integration capabilities and advanced security.
- Includes dedicated support and SLA-backed uptime for API customers.
- Requires additional infrastructure and resources for hosting and maintenance.
Licensing ensures compliance and provides access to:
- Installer, developer guide, and live WSDL/XSD documentation.
- Sample integrations such as an Outlook plug-in, BizTalk orchestration, and a SharePoint web part.
2. Features included in the API license
| Feature | Description |
|---|---|
| Full API access | SOAP, REST, and JSON endpoints for all supported modules |
| Authentication options | Credentials, Windows authentication, and token-based security |
| Digital signatures | Supported for document acknowledgements |
| Developer resources | Technical documentation, WSDL/XSD schemas, and sample code |
3. Security and licensing note
- If the API license is missing, service calls return invalid responses.
- Use SSL/TLS to secure API endpoints and restrict access by IP.
- Authentication tokens are generated using PublicTokenKey; changing this invalidates existing tokens.
4. Supported modules and endpoints
| Module | Example operations |
|---|---|
| Core | Authenticate, GetServerInfo, AvailableConnections |
| Documents | GetDocument, CreateNewDocument, AcknowledgeDocument |
| Audits | GetAudit, CreateNewAudit |
| Occurrences | CreateNewOccurrence, GetOccurrences |
| Incidents | GetIncident, GetIncidents |
| Non-conformance | GetNonConformance, CreateNewNonConformance |
| Training | GetCourses, AddCompletedEvent |