How to read this documentation

Welcome to the VELAONE API documentation. We have organized each section consistently and intuitively to help you navigate and understand our documentation efficiently. Below is a guide on how to read and interpret the information presented.

Each section and its associated requests are structured as follows:

  1. Diagram of steps: A visual representation of the process flow, showing the sequence of actions and decision points in the API workflow.
  2. Title: The name of the section.
  3. Main information: Description of that section.
  4. Sub-title: The name of the process flow.
  5. Real-life scenario:

    A practical example to illustrate the use case. e.g., "When a guest arrives and all tables are already assigned, you can add them to the waiting list."

  6. Request:
    Definition Example 
            Describes the data types of each key inside the request.
        e.g.,
        
            {  
                "requestType": string, 
                "actionType": string
            }
        
        
            Provides a sample request, with real values.
        e.g.,
        
            {  
                "requestType": "waiting",  
                "actionType": "add"
            }
  7. Response:
    Definition Example 
            Outlines the different data types of the response you might receive from the API.
        
            {  
                "phone": string, 
                "name": string
            }
        
        
            Shows a sample response with real data.
        
            {  
                "phone": "1234567890", 
                "name": "John Doe"
            }

We suggest getting to know this structure before delving into particular API endpoints. This method will assist you in navigating the documentation more effectively and finding the information you need for successful integration with VELAONE APIs.

If you have any questions about interpreting the documentation or need further clarification, please feel free to contact our developer support team.