mirror of
https://github.com/alextselegidis/easyappointments.git
synced 2024-11-28 10:53:40 +03:00
Updated the REST API based on the latest API changes
This commit is contained in:
Alex Tselegidis
parent
2bab1494dc
commit
3422f06cc5
1 changed files with 96 additions and 70 deletions
148
docs/rest-api.md
148
docs/rest-api.md
|
|
@ -6,7 +6,7 @@ Easy!Appointments offers a flexible REST API that will enables you to handle all
|
|||
|
||||
### Open API Specification (Swagger File)
|
||||
|
||||
The project has a ready-made [swagger file](https://raw.githubusercontent.com/alextselegidis/easyappointments/master/swagger.yml) you can download and use in order to create your client.
|
||||
The project has a ready-made [OpenApi file](https://raw.githubusercontent.com/alextselegidis/easyappointments/master/openapi.yml) you can download and use in order to create your client.
|
||||
|
||||
This file can also be imported into Postman, so that you can quickly get started making requests towards your installation.
|
||||
|
||||
|
|
@ -14,7 +14,9 @@ You will find more information about Open API and Swagger on [swagger.io](https:
|
|||
|
||||
## Making Requests
|
||||
|
||||
The new API (v1) supports [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) which means that you will have to send the "Authorization" header with every request you make. **Always use SSL/TLS when making requests to a production installation.** That way you can ensure that no passwords will be stolen during the requests. The API expects the username and password of an admin user.
|
||||
The API (v1) supports [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) which means that you will have to send the "Authorization" header with every request you make. **Always use SSL/TLS when making requests to a production installation.** That way you can ensure that no passwords will be stolen during the requests. The API expects the username and password of an administrator user.
|
||||
|
||||
Additionally you can configure your own API key in the settings page and pass it through as a Bearer Token with any of your requests.
|
||||
|
||||
The API follows the REST structure which means that the client can use various HTTP verbs in order to perform various operations to the resources. For example you should use a GET request for fetching resources, a POST for creating new and PUT for updating existing ones in the database. Finally a DELETE request will remove a resource from the system.
|
||||
|
||||
|
|
@ -54,16 +56,28 @@ If you need to get only specific values from each JSON resource provide the `fie
|
|||
http://ea-installation/index.php/api/v1/appointments?fields=id,book,hash,notes
|
||||
```
|
||||
|
||||
### Aggregate
|
||||
### Aggregate (Deprecated)
|
||||
|
||||
Aggregate related data into result payload by providing the `aggregates` parameter.
|
||||
|
||||
> Notice: this parameter only applies to appointments and will be removed in the future (use the `with` paramter instead).
|
||||
|
||||
```
|
||||
http://ea-installation/index.php/api/v1/appointments?aggregates
|
||||
```
|
||||
|
||||
*This parameter is currently only available for appointment resources.*
|
||||
|
||||
### With
|
||||
|
||||
Attach resources to the response payload with this parameter.
|
||||
|
||||
```
|
||||
http://ea-installation/index.php/api/v1/appointments?with=customer,service,provider
|
||||
```
|
||||
|
||||
*This parameter is only available for resources that are related to other resources.*
|
||||
|
||||
### Expected Responses
|
||||
|
||||
Most of the times the API will return the complete requested data in a JSON string but there are some cases that the responses will contain a simple message like the following:
|
||||
|
|
@ -134,12 +148,13 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
"book": "2016-07-08 12:57:00",
|
||||
"start": "2016-07-08 18:00:00",
|
||||
"end": "2016-07-08 18:30:00",
|
||||
"hash": "asdf809a8sdf987a9d8f7",
|
||||
"notes": "These are some test notes.",
|
||||
"customerId": 56,
|
||||
"providerId": 4,
|
||||
"serviceId": 7,
|
||||
"googleCalendarId": 134
|
||||
"hash": "apTWVbSvBJXR",
|
||||
"location": "Test Street 1A, 12345 Some State, Some Place"
|
||||
"notes": "This is a test appointment.",
|
||||
"serviceId": 1,
|
||||
"providerId": 2,
|
||||
"customerId": 3,
|
||||
"googleCalendarId": null
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -158,9 +173,11 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
"book": "2016-07-08 12:57:00",
|
||||
"start": "2016-07-08 18:00:00",
|
||||
"end": "2016-07-08 18:30:00",
|
||||
"notes": "These are some test notes.",
|
||||
"providerId": 4,
|
||||
"googleCalendarId": 474
|
||||
"hash": "apTWVbSvBJXR",
|
||||
"location": "Test Street 1A, 12345 Some State, Some Place",
|
||||
"notes": "This is a test unavailability.",
|
||||
"providerId": 1,
|
||||
"googleCalendarId": null
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -175,15 +192,17 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 97,
|
||||
"id": 1,
|
||||
"firstName": "John",
|
||||
"lastName": "Doe",
|
||||
"email": "john@doe.com",
|
||||
"phone": "0123456789",
|
||||
"address": "Some Str. 123",
|
||||
"city": "Some City",
|
||||
"email": "john@example.org",
|
||||
"phone": "+10000000000",
|
||||
"address": "Test Street 1A",
|
||||
"city": "Some Place",
|
||||
"zip": "12345",
|
||||
"notes": "Test customer notes."
|
||||
"timezone": "UTC",
|
||||
"language": "english",
|
||||
"notes": "This is a test customer."
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -198,12 +217,12 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 74,
|
||||
"name": "Male Haircut",
|
||||
"duration": 60,
|
||||
"price": 10.00,
|
||||
"currency": "Euro",
|
||||
"description": "Male haircut trends.",
|
||||
"id": 1,
|
||||
"name": "Test Service",
|
||||
"duration": 15,
|
||||
"price": 0.00,
|
||||
"currency": "EUR",
|
||||
"description": "This is a test service.",
|
||||
"availabilitiesType": "flexible",
|
||||
"attendantsNumber": 1,
|
||||
"categoryId": null
|
||||
|
|
@ -223,9 +242,9 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 5,
|
||||
"id": 1,
|
||||
"name": "Test Category",
|
||||
"description": "This category includes test services"
|
||||
"description": "This is a test category."
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -240,20 +259,22 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 143,
|
||||
"firstName": "Chris",
|
||||
"id": 1,
|
||||
"firstName": "Jason",
|
||||
"lastName": "Doe",
|
||||
"email": "chris@doe.com",
|
||||
"mobile": "012345679-0",
|
||||
"phone": "0123456789-1",
|
||||
"address": "Some Str. 123",
|
||||
"city": "Some City",
|
||||
"state": "Some City",
|
||||
"email": "jason@example.org",
|
||||
"mobile": "+10000000000",
|
||||
"phone": "+10000000000",
|
||||
"address": "Test Street 1A",
|
||||
"city": "Some Place",
|
||||
"state": "Some State",
|
||||
"zip": "12345",
|
||||
"notes": "Test admin notes.",
|
||||
"timezone": "UTC",
|
||||
"language": "english",
|
||||
"notes": "This is a test admin.",
|
||||
"settings":{
|
||||
"username": "chrisdoe",
|
||||
"password": "p@ssw0rd",
|
||||
"password": "Password@123",
|
||||
"notifications": true,
|
||||
"calendarView": "default"
|
||||
}
|
||||
|
|
@ -273,31 +294,33 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 143,
|
||||
"firstName": "Chloe",
|
||||
"id": 1,
|
||||
"firstName": "Chris",
|
||||
"lastName": "Doe",
|
||||
"email": "chloe@doe.com",
|
||||
"mobile": "012345679-0",
|
||||
"phone": "0123456789-1",
|
||||
"address": "Some Str. 123",
|
||||
"city": "Some City",
|
||||
"email": "chris@example.org",
|
||||
"mobile": "+10000000000",
|
||||
"phone": "+10000000000",
|
||||
"address": "Test Street 1A",
|
||||
"city": "Some Place",
|
||||
"state": "Some State",
|
||||
"zip": "12345",
|
||||
"notes": "Test provider notes.",
|
||||
"timezone": "UTC",
|
||||
"language": "english",
|
||||
"notes": "This is a test provider.",
|
||||
"services": [
|
||||
1,
|
||||
5,
|
||||
9
|
||||
],
|
||||
"settings":{
|
||||
"username": "chloedoe",
|
||||
"password": "p@ssw0rd",
|
||||
"username": "chrisdoe",
|
||||
"password": "Password@123",
|
||||
"notifications": true,
|
||||
"googleSync":true,
|
||||
"googleCalendar": "calendar-id",
|
||||
"googleToken": "23897dfasdf7a98gas98d9",
|
||||
"syncFutureDays":10,
|
||||
"syncPastDays":10,
|
||||
"googleSync": false,
|
||||
"googleCalendar": null,
|
||||
"googleToken": null,
|
||||
"syncFutureDays": 90,
|
||||
"syncPastDays": 30,
|
||||
"calendarView": "default",
|
||||
"workingPlan":{
|
||||
"monday":{
|
||||
|
|
@ -373,23 +396,26 @@ You can also try the GET requests with your browser by navigating to the respect
|
|||
|
||||
```
|
||||
{
|
||||
"id": 143,
|
||||
"firstName": "Chris",
|
||||
"id": 1,
|
||||
"firstName": "Jessy",
|
||||
"lastName": "Doe",
|
||||
"email": "chris@doe.com",
|
||||
"mobile": "012345679-0",
|
||||
"phone": "0123456789-1",
|
||||
"address": "Some Str. 123",
|
||||
"city": "Some City",
|
||||
"email": "jessy@example.org",
|
||||
"mobile": "+10000000000",
|
||||
"phone": "+10000000000",
|
||||
"address": "Test Street 1A",
|
||||
"city": "Some Place",
|
||||
"state": "Some State",
|
||||
"zip": "12345",
|
||||
"notes": "Test secretary notes.",
|
||||
"timezone": "UTC",
|
||||
"language": "english",
|
||||
"notes": "This is a test secretary.",
|
||||
"providers": [
|
||||
53,
|
||||
17
|
||||
],
|
||||
"settings":{
|
||||
"username":"chrisdoe",
|
||||
"password":"p@ssw0rd",
|
||||
"username":"jessydoe",
|
||||
"password":"Password@123",
|
||||
"notifications": true,
|
||||
"calendarView": "default"
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue