The BungalowNet API is your gateway to seamlessly integrating with our systems, empowering you to access booking information, manage reservations, and provide an exceptional experience to your customers. Designed with developers in mind, our API is efficient, reliable, and easy to use.
This article serves as a starting point to help you integrate our API smoothly and make the most of its features.
Getting Started
To get started, follow these steps:
1. Prerequisites
Before integrating with our API, ensure you have:
- Approval from BungalowNet as an authorized partner.
- Your API key, issued by the BungalowNet IT department.
- Basic familiarity with RESTful APIs and JSON format.
2. Obtain Your API Key
Contact the BungalowNet IT department to request an API key. Keys are valid for 3 months and can be extended by an additional 30 days upon request. Keep your API key secure and confidential, as it grants access to your integration.
3. Set Up Your Environment
- Access our test environment, designed for integration testing without affecting production data.
- Use tools like Postman or cURL to test API requests during development.
4. Explore the Documentation
Our API knowledge base contains detailed articles about available endpoints, parameters, and expected responses. Additionally, use our Swagger documentation by logging in with Basic Authorization:
- Username:
bngapi - Password: Your API key.
Authentication and Your First API Call
Authentication
The BungalowNet API uses API key-based authentication. Use our API supplying the following HTTP headers:
Example Authentication Header:
x-security-key: <YOUR_API_KEY>
x-partner: <YOUR_PARTNER_ID>
language: <NL, EN, DE, FR>
Making Your First API Call
Here’s a basic example to retrieve a list of available houses:
Request:
curl -X GET "https://bungalow/api/v1/booking/searchHouses" \
-H "x-security-key: <YOUR_API_KEY> x-partner: <YOUR_PARTNER_ID>"
Response:
{
"houseList": [
{
"houseId": 0,
"name": "string",
"nrPersons": {
"name": "string",
"value": {}
},
Test Environment
We provide a test environment for safe integration testing. Use this environment to:
- Test API calls without impacting live production data.
- Simulate real-world scenarios and workflows.
Access details for the test environment are shared alongside your API key.
Key API Features
Our API supports a variety of features to enhance your integration. Commonly used endpoints include:
-
Retrieve House List
Example: Fetch available house list with house description, number of persons, number of bedrooms, surface, images, price information. -
Pre-register Reservations
Send guest information and reservation data, as guest goes through the booking steps. Receive a transaction ID, that will become the reservation code once the reservation is finalized. -
Finalize Reservations
Programmatically book available units and receive booking confirmations. -
Retrieve Available House Units
Example: Fetch available house units for a specific period. -
Retrieve Used House Types
Used for filtering purposes, you can fetch the list of existing accommodation types: group accommodations, villas, apartments. -
Retrieve Price
Fetch price specifications for a certain accommodation and specific period. -
Retrieve Optional Services
Fetch the list of optional services added to a specific accommodation, with service name, cost, cost type, service group name, keyword for easy mapping. -
Retrieve Park Active Houses
Fetch the list of accommodations currently active in the system, with ID and name only. - Retrieve Park Data
Fetch Park Conditions, park virtual tour link and the list of park facilities offered, with facility ID, facility name and keyword for easy mapping.
Detailed guides for each feature are available in our knowledge base.
Translated properties are available in 4 languages: NL, EN, DE and FR. The default language is NL.
Best Practices
To ensure smooth and efficient integration, follow these best practices:
-
Secure Your API Key
- Store your API key in environment variables or secret management tools.
- Never expose keys in public repositories or logs.
-
Optimize Requests
- Stay within the limit of 100 requests per minute to avoid throttling.
- Implement caching for frequently requested data to reduce redundant calls.
-
Handle Errors Gracefully
-
Check the HTTP status codes in API responses for success or errors.
-
Example of a rate limit error:
{ "status": "error", "message": "Rate limit exceeded", "code": 429 }
-
-
Use the Test Environment
- Always test your integration thoroughly in the sandbox before moving to production.
Troubleshooting and Support
Common Issues
- Invalid API Key: Verify that your key is included correctly in the
Authorizationheader. - Rate Limit Errors: Ensure your application stays within the 100 requests/minute limit.
Resources
- Refer to our knowledge base for detailed articles on endpoints and troubleshooting.
- Use the Swagger interface for interactive testing and understanding endpoints.
Contact Support
If you encounter issues or need assistance, reach out to our IT department for help via our help center.
Moving to Production
Once your integration is thoroughly tested, you can move to production:
-
Final Checklist:
- Verify that your application handles errors and adheres to rate limits.
- Replace sandbox environment URLs with production URLs.
-
Approval:
- Contact the BungalowNet IT department to request approval for production access.
Stay Updated
Keep an eye on announcements for new features, deprecations, or updates:
- Versioning: Monitor API version-specific documentation to maintain compatibility.
- Communication: Subscribe to our updates to receive critical announcements.
Conclusion
Thank you for choosing the BungalowNet API for your integration needs. We are committed to providing you with a reliable and efficient service. If you have any questions, feedback, or suggestions, don’t hesitate to reach out. Together, we can create an exceptional experience for your customers.
Happy Integrating! 🎉
Help Center