NP6 API Reference (8.1.0)
This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.
If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.
All requests to NP6 CM APIs must be authenticated using an API key provided by NP6. The API key must be included in the HTTP headers of each request using the following format: x-key: your-api-key
API keys are unique and should be kept confidential. Avoid sharing or exposing your API key in public repositories or client-side code.
If you lose your API key, please submit a support request at https://support.chapsvision.com and include your client account information. To request a new API key for your account, contact us at service.commercial@np6.chapsvision.com.
To ensure optimal performance and protect our infrastructure, NP6 APIs enforce rate limits on incoming requests. These limits may vary depending on the type of account and the nature of the API being accessed.
If you exceed the allowed request rate, the API will return a 429 Too Many Requests response. In such cases, we recommend implementing an exponential backoff strategy before retrying.
Rate limit information may be provided in response headers, such as:
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset
For high-throughput use cases or specific needs, please contact our team to discuss appropriate limits and access policies.
You will find below the attributes to pass in the HTML content of your actions to active CM tracking.