Help CenterThis document outlines the policies governing the use of our API. By accessing or using the API, you agree to adhere to these terms and conditions. These policies are designed to ensure secure, reliable, and efficient interactions with BungalowNet systems.
2. Access and Authentication
- API Key Issuance: API keys are issued by the BungalowNet IT department upon successful completion of the application process. This process may include providing valid contact information and agreeing to a separate API License Agreement. Keys are initially valid for 3 months and may be extended upon request. Extensions are typically granted for 30 days.
- Authentication: Partners must authenticate all API requests using their API key. When accessing the Swagger documentation, use the username
bngapiand your API key as the password. - Key Confidentiality: API keys must be kept confidential. Do not share them with unauthorized parties, embed them in public repositories, or expose them in client-side code.
- Key Management: Partners are responsible for managing their API keys. This includes securely storing the key, promptly reporting any suspected compromise, and immediately revoking keys that are no longer needed.
- Key Revocation: The BungalowNet IT department may revoke API keys at any time, with or without cause. Partners must notify the IT department immediately if a key is suspected to be compromised at bnapi@bungalow.net or via our help center.
3. Usage Limits
- Rate Limiting: API usage is limited to 100 requests per minute per API key by default. Exceeding this limit may result in temporary throttling or suspension of access. Higher rate limits may be available upon request and approval by the IT department.
- Request Concurrency: To ensure system stability, Partners may be limited in the number of concurrent requests they can make to the API.
4. Monitoring and Security
- Usage Monitoring: API usage will be actively monitored to ensure compliance with this policy, detect anomalies and maintain service quality.
- Logging: All API requests and responses, including timestamps and source IP addresses, are logged for security auditing, troubleshooting, and performance analysis purposes.
- Anomaly Detection: Unusual or suspicious activity, such as sudden spikes in traffic, requests from unexpected locations, or attempts to access unauthorized resources, may trigger alerts and lead to temporary suspension of API access or additional verification requirements.
- Security Audits: BungalowNet may conduct periodic security audits of Partner integrations to ensure compliance with this policy.
5. Permitted Use
- Scope of Use: The API is intended for authorized integrations with BungalowNet systems for the purposes defined in the API License Agreement.
- Prohibited Activities:
- Reverse engineering or attempting to extract proprietary information from the API.
- Using the API for unauthorized purposes, including but not limited to competitive analysis, data scraping, or any activity that may negatively impact BungalowNet systems.
- Sharing or redistributing API access or API keys without explicit written permission from BungalowNet.
- Attempting to bypass rate limits or other usage restrictions.
- Interfering with or disrupting the API or any BungalowNet systems.
- Using the API to transmit any unlawful, harmful, threatening, abusive, harassing, defamatory, vulgar, obscene, hateful, or racially, ethnically, or otherwise objectionable content.
6. Test Environment
- Integration Testing: A dedicated test environment ("Sandbox") is provided for partners to test their integrations and ensure they function correctly before deploying in the production environment.
- Access to Resources: The Sandbox environment provides access to a subset of production data and resources, including API endpoints and documentation.
- Swagger Documentation: Accessible by logging in with your assigned credentials: use the username
bngapiand your API key as the password.
7. Data Security and Privacy
- Data Handling: Partners must ensure that all data retrieved via the API is handled securely and in compliance with all applicable data protection laws and regulations, including but not limited to the General Data Protection Regulation (GDPR).
- Storage Restrictions: Sensitive data, such as personally identifiable information (PII), must not be stored in unencrypted formats or shared with unauthorized parties.
- Data Minimization: Partners should only request and process the data that is strictly necessary for their integration.
8. Support and Maintenance
- Support Channels: Assistance is available through our IT department at bnapi@bungalow.net or via our help center. Partners are encouraged to consult the resources provided in this knowledge base before contacting support.
- Updates and Deprecations: BungalowNet will make reasonable efforts to provide Partners with at least 30 days' advance notice of any breaking changes to the API. Deprecation policies are designed to minimize disruptions to Partner integrations.
- Service Level Agreements: BungalowNet may offer different service level agreements (SLAs) for the API, depending on the Partner's needs and contract. These SLAs may define uptime guarantees, response times, and support availability.
9. Compliance and Legal Considerations
- Regulatory Compliance: Partners are solely responsible for complying with all relevant legal and regulatory requirements applicable to their use of the API, including but not limited to data protection, consumer protection, and intellectual property laws.
- Liability: BungalowNet is not liable for any losses, damages, or expenses arising from Partner's use or misuse of the API, including but not limited to indirect, incidental, consequential, special, or exemplary damages, or damages for loss of profits, revenue, data, or use, even if BungalowNet has been advised of the possibility of such damages. This limitation of liability applies to the fullest extent permitted by law.
- Indemnification: Partner agrees to indemnify and hold harmless BungalowNet, its affiliates, officers, directors, employees, and agents from and against any and all claims, liabilities, damages, losses, costs, expenses, or fees (including reasonable attorneys' fees) arising out of or relating to Partner's use of the API, Partner's breach of this policy, or Partner's violation of any applicable law or regulation.
- Termination: BungalowNet reserves the right to suspend or terminate access at any time, with or without cause, in cases of policy violations, security risks, or non-payment of fees, where applicable.
10. Enforcement and Violations
- Violation Consequences: Violating this policy may result in:
- Temporary or permanent suspension of API access.
- Permanent revocation of API keys.
- Legal action for severe breaches, including but not limited to unauthorized access, data breaches, or intellectual property infringement.
- Dispute Resolution: Partners may contact the IT department to attempt to resolve disputes regarding API access or usage at bnapi@bungalow.net or via our help center.
11. Partner Responsibilities
- Integration Compliance: Partners are responsible for ensuring their applications and systems comply with this policy, the API documentation, and all applicable laws and regulations.
- Error Handling: Partners must implement proper error handling in their applications to gracefully manage API responses, including rate limit errors, timeouts, and other error conditions.
- Security Best Practices: Partners must follow security best practices to protect their API keys, prevent unauthorized access to their systems, and safeguard any data obtained from the API.
12. Feedback and Improvements
We welcome feedback from our partners to improve the API and developer experience. Please contact us with any suggestions or issues at bnapi@bungalow.net or via our help center.
13. Changes to this Policy
BungalowNet may update this API policy from time to time. Partners will be notified of any material changes. Continued use of the API after any such changes constitutes acceptance of the revised policy.
This policy ensures secure, consistent, and efficient use of the BungalowNet API. By using the API, you acknowledge that you understand and agree to these terms.
Last Updated: 05.12.2024
Contact Information: BungalowNet IT Department: bnapi@bungalow.net , help center.