Difference between revisions of "API V2.0"

From Beds24 Wiki
Jump to navigation Jump to search
Line 12: Line 12:
  
 
= Scopes =
 
= Scopes =
Each category of API endpoint (except /authentication) requires the corrosponding scope to access.
+
Each category of API endpoint (except /authentication) requires the corresponding scope to access.
  
 
Some categories have additional scopes that allow access to personal or financial information. For example, the "bookings" scope would grant access to a booking's basic information such as the check-in and checkout dates. To access personal information such as the name of a guest, the "bookings-personal" scope would be required. Similarly, to access the invoice of a bookings, the "bookings-financial" scope would be required.
 
Some categories have additional scopes that allow access to personal or financial information. For example, the "bookings" scope would grant access to a booking's basic information such as the check-in and checkout dates. To access personal information such as the name of a guest, the "bookings-personal" scope would be required. Similarly, to access the invoice of a bookings, the "bookings-financial" scope would be required.
  
Each scope must also have an acompanying method. For example "get:bookings" would grant read access to bookings, but in order to create a new booking "post:bookings" would be required.
+
Each scope must also have an accompanying method. For example "get:bookings" would grant read access to bookings, but in order to create a new booking "post:bookings" would be required.
  
 
The "all" method may be used as a shortcut to grant access to all methods. For example "all:bookings" would allow for the reading, updating, creating and deleting of bookings.
 
The "all" method may be used as a shortcut to grant access to all methods. For example "all:bookings" would allow for the reading, updating, creating and deleting of bookings.

Revision as of 07:19, 3 March 2022


API Version 2.0
This page explains the capabilities of the API Version 2.0 and explains how to use it. 

1 Capabilities

2 Tokens

3 Scopes

Each category of API endpoint (except /authentication) requires the corresponding scope to access.

Some categories have additional scopes that allow access to personal or financial information. For example, the "bookings" scope would grant access to a booking's basic information such as the check-in and checkout dates. To access personal information such as the name of a guest, the "bookings-personal" scope would be required. Similarly, to access the invoice of a bookings, the "bookings-financial" scope would be required.

Each scope must also have an accompanying method. For example "get:bookings" would grant read access to bookings, but in order to create a new booking "post:bookings" would be required.

The "all" method may be used as a shortcut to grant access to all methods. For example "all:bookings" would allow for the reading, updating, creating and deleting of bookings.

4 POST method

4.1 Creating/modifying multiple items

All POST endpoints accept an array of items (an item may be a booking, message, property etc).

It is possible to create and modify multiple different items in one request this way.

All existing "POSTable" items will have an "id" field to uniquely identify it.

  • To create a new item, just do not include an id.
  • To modify an existing item, include its id.

4.2 Subitems

Some items can contain subitems. For example, a booking may contain an "invoice item" and an "info item".

Subitems generally work in the same way as their parent items.

To add a new subitem to an item, include the subitem without an id.

Example: add a new info item to a booking:
{
   "id": {bookingId},
   "infoItems": [
       {
           "code": "this will create",
           "text": "a new info item"
       }
   ]
}

To update an existing subitem, include the subitem's id.

Example: update a booking's info item:
{
   "id": {bookingId},
   "infoItems": [
       {
           "id": {infoItemId},
           "text": "this info item will have its text changed"
       }
   ]
}

To delete a subitem, include only the subitem's id.

Example: delete a booking's info item:
{
   "id": {bookingId},
   "infoItems": [
       {
           "id": {infoItemId},
       }
   ]
}

4.3 Responses

All POST requests will have a standard response.

4.3.1 Structure

Responses will be an array containing a number of response items equal to the number of items in the request.

Each response item will contain a "success" boolean field. Success will be false if there were any errors in processing the item.

Note: Success being false does not necessarily mean that nothing has changed. 
E.g. if a valid booking with an invalid info item is posted, the booking will be created but the info item will not. Success will be false in this case because there was an error.

A response item may also contain one or more of the following:

  • New - contains information about newly created items and subitems. For example, the id of a newly created booking, or the id of a new info item for an existing booking.
  • Modified - contains information about modified items and subitems. For example, if the departure date of a booking is changed, this field will have information confirming this change.
  • Errors - Contains information about fatal issues with an item or subitem in the request. An error means that an attempt was made to create or change an item or subitem, but that attempt failed.
  • Warnings - Contains information about non-fatal issues with an item in the request. A warning means that an item or subitem was created or changed, but, for example, a non-required field had invalid data provided.
  • Info - Contains general information about what has happened to the request.

These provide additional

4.3.1.1 Order of response items

The order of the items in the response will correspond to the order that items were sent in the request.

Example: POST two message for different bookings:
   [
       {
           "bookingId": 1111111,
           "message": "a message"
       },
       {
           "bookingId": 2222222,
           "message": "a different message"
       },
   ]
Example: response order for the above request:
   [
       {
           "success": true,
           "info": [
               {
                   "message": "information about the message for booking 1111111"
               }
           ]
       },
       {
           "success": false,
           "errors": [
               {
                   "message": "an error about the message for booking 2222222"
               }
           ]
       }
   ]

5 Examples

5.1 Authentication

5.1.1 Refreshing a token

Request:

curl -X 'GET' \
  'https://api.example.com/v2/authentication/token' \
  -H 'accept: application/json' \
  -H 'refreshToken: Ea6DftE50aYYRe/qAd9SkQaSmTF6kaLQxH6gtRxO1h10yVC64d4qIj4BGiQOU+y5'

Response:

{
  "token": "wEoJHQIwRrLwHqTqAsn0/XjzaZkVk4E8sSDwbRN2HKDlulkt6n7aHQCcvdqfX+y5",
  "expiresIn": 3600
 }