Skip to main content

API Reference - Introduction

Welcome to the EasyWeek API Reference, your comprehensive guide to integrating EasyWeek's online booking functionalities into your applications. This documentation provides detailed information on available endpoints, request and response formats, authentication methods, and more.

The EasyWeek API is a robust tool meticulously crafted to enable online booking functionality for various business categories, including but not limited to beauty salons, barbershops, healthcare facilities, and entertainment venues. The EasyWeek API is offering a range of features that can be used to create custom booking flows, integrate with chatbots, AI systems, and custom management solutions.

Getting Started​

Before you begin, make sure you have obtained your API key to authenticate your requests. If you haven't generated an API key yet, refer to the API Key Guide for instructions.

Base URL​

All API requests should be made to the base URL.

Authentication​

To access the EasyWeek API, you need to include your API key in the headers of your requests. The authentication process is explained in detail in the Authentication Guide.

Rate Limits​

Please be aware of the rate limits imposed on API requests to ensure fair usage and system stability. Refer to the Rate Limits section for more information.

Error Handling​

Understand how errors are handled in the EasyWeek API by referring to the Error Handling Guide. This section provides insights into common error responses and their meanings.

Pagination​

For endpoints that return a large set of data, the EasyWeek API supports pagination. Learn how to navigate through paginated results in the Pagination Guide.

Explore Endpoints​

Now that you are familiar with the basics, explore the available endpoints in the categories below:

  • Config: Retrieve information about staffers, locations, and services for your EasyWeek integration. This category provides everything you need to prepare the payload for creating bookings.

  • Availability: Retrieve information about the availability of services, time slots, and resources. Use these endpoints to display real-time availability to your users.

  • Booking: Perform booking-related actions, such as creating new bookings, retrieving booking details, and managing existing bookings. These endpoints are crucial for handling reservations made through your integration.

Explore the documentation for each category to understand the specific endpoints, request and response formats, and usage details. If you have any questions or need further clarification, feel free to reach out to our support team.

Support​

Please note that this is a high-level outline, and you should provide detailed information for each endpoint, including request headers, query parameters, request body (if applicable), and specific response structures. Additionally, make sure to document any authentication requirements and security considerations for your API.

The EasyWeek API is proudly developed and maintained by Awescode Agency. The dedicated team behind this project, who have worked tirelessly to create a robust and user-friendly API for your business needs. If you have any questions, feedback, or require assistance while using the EasyWeek API, please don't hesitate to reach out to our team for support. We are committed to delivering a seamless experience for your business analytics and data management.