Azuga uses REST API standards to ensure a consistent and predictable interface for developers. This documentation provides an overview of the general patterns and request methods used in our API. Follow the guidelines below to understand how to interact with our endpoints effectively.
HTTP Request Methods
GET - Retrieves data from the server.
Usage: Use this method to request data from a specified resource.
Example: GET /users retrieves a list of users.
POST - Submits data to be processed to a specified resource.
Usage: Use this method to create a new resource.
Example: POST /users creates a new user with the provided data.
PUT - Updates a current resource with new data.
Usage: Use this method to update an existing resource.
Example: PUT /users/{userId} performs a complete update of an existing user within the system.
PATCH - Partially updates a current resource.
Usage: Use this method to apply partial modifications to a resource.
Example: PATCH /users/{userId} updates certain fields of the user with the specified {userId}.
DELETE- Deletes a specified resource.
Usage: Use this method to remove a resource.
Example: DELETE /users/{userId} deletes the user with the specified {userId}.