Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The REST API can be used to fetch or create data in the Maxxton system. The REST API is the successor of the SOAP XML Webservice.

Documentation on the usage of the REST API can be found here: https://developers.maxxton.com/

Create REST API authentication

Access to the REST API can be configured in the Maxxton software backoffice

  1. In Maxxton software go to the "Back Office Manager".
  2. In the menu on the left select "API User".
  3. Scroll down and click "New API User".
  4. Fill in all fields and click "create".
  5. When the API user is created, click on it and open it.
  6. Scroll down and assign the correct admin organisations.
  7. Click "Create API key"
  8. Fill in a proper description.
  9. Assign the correct distribution channel to the API key or keep it empty to give it access to the information of all distribution channels(this means all data that is restricted to a particular distribution channel like reservations which are created by a particular distribution channel)
  10. Select the correct reservation category. This will be used to auto-select and only allow this particular reservation category to create a reservation for. In case no fixed reservation category is used, the reservation category can be kept empty and this can be provided in the create reservation calls without any limitations.
  11. Select the min-release-status, this means which data should be returned to the client based on release statuses.  When selected close it will provide access to close and all statuses up to everybody. When selected everybody it will only provide access to the everybody status. Same applies to the other release statuses in between.
  12. When finished click "create", the window will close.
  13. The created API key shows up, click the dots at the end of the new API line which you just created and click "details"
  14. Go to the "edit permissions" button
  15. Add the permissions to the different features that are needed.
  16. Now the API access is configured and the application can authenticate using: https://developers-test.maxxton.com/maxxton/v1/documentation/html5/index.html#_oauth2

FAQ:

  • The API key configured on the production environment is not copied to the acceptance environment. This means you need to create 2 API keys, one for the production environment and one for the acceptance environment.
  • No labels