API Fair Use Policy
Defines acceptable use of the Zaptec API, including rate limits, Service Bus recommendations, data handling, security requirements, prohibited activities, and enforcement.
1. General principles
The Zaptec API is provided to foster innovation and enable integration with the Zaptec charging ecosystem. Integrators, developers, and third parties must use the API responsibly and efficiently. Your usage must not negatively affect the performance, stability, or security of the Zaptec platform, or the experience of other users.
Fair use means using the API in ways that align with its intended purpose and respect the shared infrastructure.
2. API usage and rate limiting
To maintain API stability and performance for all users, follow these requirements and recommendations.
Keep API usage within the standard rate limit of 10 requests per second per account. Use Service Bus subscriptions for near real-time updates instead of aggressive polling.
-
Rate limits: The standard rate limit is 10 requests per second per account. This limit supports fair usage and reliable performance for all users.
Important: Please ensure your usage stays within this limit. If you are developing an application with high throughput requirements or expect substantial growth, please reach out to us. We will gladly review your use case and work with you to find a suitable and scalable arrangement. Read more on API rate limiting.
-
Use documented APIs only: Integrators must use only officially documented and supported API endpoints. Internal, undocumented, or reverse-engineered API calls, including calls derived from the Zaptec Portal or other internal tools, are strictly prohibited. This supports system stability, security, and consistent support for integration partners.
-
Do not use aggressive polling: Aggressive polling to detect changes is prohibited. It results in rate limiting and may lead to suspension or revocation of access.
-
Use Service Bus subscriptions: For near real-time updates to installation and charger states, integrators, developers, and third parties should use the installation or UserGroups Service Bus subscriptions. This is the recommended way to stay informed about changes without continuous API polling.
-
Retrieve data efficiently:
- Fetch data only when necessary.
- Fetch data that changes infrequently, such as installation or charger lists, less often. For example, fetch this data at most once an hour or when you detect an unknown charging station. Store the data locally in your integration.
- When you fetch details for a specific charging station, use
nameFilterin the/api/chargerscall with the charger serial number. This avoids retrieving unnecessary data. - Some commands require the Zaptec backend to retrieve significant amounts of data. For these resource-intensive requests, implement retries with exponential backoff to give the system time to process requests and avoid overwhelming the API during peak load.
-
Maintain local state: Integrators, developers, and third parties should maintain a local state of charger and installation data in their integration. Keep this state synchronised through Service Bus events to reduce frequent API calls for current data.
3. Data handling and storage
- Integrators, developers, and third parties must handle all data retrieved from the Zaptec API in accordance with applicable privacy laws and regulations, including the General Data Protection Regulation (GDPR).
- You may cache and store data locally to improve the performance and responsiveness of your integration. You are responsible for keeping locally stored data reasonably up to date by using recommended methods such as Service Bus subscriptions.
4. Security and authentication
- Users and integrators are responsible for maintaining the confidentiality and security of their Zaptec account credentials and API access tokens.
- Users and integrators must not share API credentials with unauthorised third parties.
Important: Do not capture, use, or store Zaptec users' credentials or passwords. Use Zaptec's documented third-party onboarding flow to connect users to your integration.
- Attempts to gain unauthorised access to the Zaptec API, other users' data, or to circumvent security measures are strictly prohibited. Zaptec may take immediate action, including terminating access.
- Accessing the Zaptec Cloud or API through automated, unethical, or unconventional means other than the provided API is prohibited under Zaptec's Terms and Conditions.
5. User-Agent header requirement
All applications accessing the Zaptec API must include a descriptive User-Agent header in every request. This header identifies the source of API calls and helps Zaptec provide support and trace requests to a specific application.
Format the User-Agent string to clearly identify your application. Include the application version when possible to support faster troubleshooting.
Example
Use a simple, readable User-Agent format.
- Format:
Application-Name/Version - Example:
MyAwesomeEVChargerApp/1.2.0
6. Prohibited activities
Integrators, developers, and third parties are prohibited from using the Zaptec API for the following activities:
- Disrupting, interfering with, overloading, disabling, or damaging the Zaptec Cloud, API, or associated infrastructure.
- Using aggressive polling that violates rate limits or negatively affects the service for others.
- Using the API for unsolicited advertising, marketing, or sales activities unless Zaptec explicitly permits this through a separate agreement.
- Extracting or scraping excessive data beyond the reasonable needs of the integration in ways that affect API performance.
- Introducing malicious code, viruses, or other harmful material into the Zaptec platform through the API.
- Using the API in a way that violates applicable local, national, or international laws or regulations.
- Misrepresenting an integrator's or user's identity, the origin of API requests, or the nature of an integration.
7. Use of undocumented APIs
Use only officially documented and supported Zaptec APIs. Undocumented, internal, or reverse-engineered endpoints are not supported for external use and may result in suspension or termination of API access.
Integrators, developers, and third parties must use only officially documented and supported APIs provided in the Zaptec API documentation. Using undocumented, internal, or reverse-engineered endpoints, including endpoints obtained by analysing Zaptec's web portal, mobile applications, or other internal systems, is strictly prohibited.
Zaptec does not guarantee that internal APIs are stable, and they may change without notice. Their use can cause system instability, integration failures, or security vulnerabilities, and may result in suspension or termination of API access.
8. Monitoring, troubleshooting, and future services
Zaptec monitors API performance and stability to maintain a high-quality experience for all users. Integrators, developers, and third parties should monitor their own systems and API usage for potential issues. During troubleshooting, visibility into interactions between your system and the Zaptec API is important.
Zaptec is reviewing technical solutions for more scalable and resilient integrations. This may introduce tiered integration services with specific service-level expectations. Zaptec will inform integrators, developers, and third parties of these changes in advance.
9. Enforcement
Failure to comply with this Fair Use Policy may result in corrective action by Zaptec, including:
- A formal warning to the integrator, developer, or third party.
- Temporary suspension of API access.
- Permanent termination of API access.
- Legal action if the violation causes significant harm to Zaptec or other parties.
10. Policy updates
Zaptec may modify or update this Fair Use Policy at any time. Integrators, developers, and third parties will be notified of significant changes. Continued use of the Zaptec API after changes take effect constitutes acceptance of the revised policy.
11. Contact information
This policy promotes system reliability, long-term supportability, and a consistent, high-quality integration experience for all partners.
Contact Zaptec's technical support or integration team to request features or report gaps in the official API.
For questions or concerns about this Fair Use Policy or your API usage, contact Zaptec Support at https://help.zaptec.com or your designated regional Zaptec support representative.
Updated about 1 month ago
