diff --git a/index.html b/index.html index f3f35ef..30022d4 100644 --- a/index.html +++ b/index.html @@ -174,26 +174,26 @@
Weave is an API aggregator for the Travel Tech industry. Weave enables applications to integrate with a number of different service providers using a single API. When the underlying service provider APIs change, the integrations built using Weave will be updated with minimal to no development effort by application developers. Weave will continue to support previous versions of its own API endpoints for a predetermined period of time to enable developers sufficient time to plan and execute updates to their product roadmaps
Domain
Requests are made to the Weave API domain eg https://use1.weaveapi.com
Requests can only be made using SSL enabled connections
API Versions
Requests will specify the Weave API version being used. If the version is omitted (or is invalid), Weave will default to the latest API version.
Deprecation schedule: Weave will support 2 previous versions for a period of 6 months before deprecation
Endpoints
Each API will have an end point eg /listings. End points may require additional query parameters (for GET requests) or body parameters (for POST requests).
Headers
Additional parameters for the request, for example authentication tokens and request destinations
@@ -207,8 +207,8 @@
Type | @@ -251,18 +251,18 @@
---|
Origin
Origin for all requests will be: https://use1.weaveapi.com
API Version
Current API version is “v1”
Request paths should be prefixed with the API version ie “/api/v1/endpoint/path”
Headers
The following headers need to be included with each request
X-WEAVE-APIKEY @@ -295,7 +295,7 @@
Returned data
Data is always returned in the format
{ @@ -306,7 +306,7 @@
Note: If the proxy target does not support the endpoint, the response will be returned with the data and raw fields as empty arrays
Errors
Errors are returned with the appropriate error code and message
{ @@ -315,6 +315,41 @@
Authentication
+This endpoint is used to obtain authentication tokens from the target PMS. The authentication token is then used in future requests (ie passed in the header as X-WEAVE-PROXY-ACCESS-TOKEN)
+/accessTokens
+POST
+Content-type: application/json
+None
+client_id: PMS user client id
+client_secret: PMS user client secret
+{ + status: true/false, + data: [ + { + access_token: ‘xs34…’ // access token to be used in future requests in the X-WEAVE-PROXY-ACCESS-TOKEN header field + expiry: 1749275583083 // expiry time of the access_token presented as the number of milliseconds since the beginning of the UNIX epoch + } + ], + raw: …. +} +
+