New Skies Digital API
New Skies Digital API (Digital API for short) is a json API to operate with the New Skies Platform. The list of allowed operations might vary based on your New Skies agent role permissions, but some examples of the supported features are creating and maintaining flight bookings as well as performing operational tasks like retrieving flight manifests.
ENROLLMENT PROCESS
The access to the API involves four different operations:
- An api-key to register and identify your application as a consumer of the Digital API has been requested and approved.
- An agent is configured in New Skies with the correct permissions to cover your use case.
- Validation of your workflow is performed prior access to prod environment is granted.
- A whitelist request for your production environment's IP(s) has been sent and has been approved by TUI (Not required for the non-production environments).
Please, check below a general guide on how to complete each of these steps.
API-Key Request
Each of the client applications consuming the New Skies Digital API must be identified by a unique API key. To request your key, please register on developer.tui portal for the API named New Skies Digital Api
Once done and approved, you will retrieve your API-Key to use with the Digital API.
The New Skies Digital API uses API keys as a simple identification layer. As such, OAuth tokens are not needed because the actual authentication is handled by the New Skies platform itself (see more details).
Notice: The developer portal will only show the production and playground (test environment for development) API key for accessing the production environment. To access other environments, a different API key will be needed for accessing.
Workflow Validation (prior PROD go-live)
To ensure correct usage of the Digital API, validation of your workflow prior go-live is mandatory. You will need to provide a few details, which are:
- Contact details (general email-address of your company)
- App-Name you used on the portal for registration to the Digital-Api.
- Production environment IP addresses or ranges
- Other environment IP addresses or ranges (like your test/development environment)
- Brief description of your usecase
- Endpoints used by your workflow, including small information about the purpose of each request.
- Overall workflow diagram
- Expected throughputs (Requests per Minute)
- Test cases performed on our playground-environment, preferably by providing a correlation-id and a time-range when the tests were performed.
You should provide all those information using this form.
Please be aware, that missing information may cause the whitelisting and go-live to be delayed.
IP Whitelist (PROD only)
The production environment is protected by an IP whitelisting that will deny all requests unless the requester's IP has been whitelisted.
Please file a request at api.flightproduction@tui.com, providing all IPs you will use on our production API, with the subject Digital API - Whitelist Request (prod).
Access to the Digital API production environment must be done only from your own production system. The access of to the production environment from a lower environment (dev, test, ...) is absolutely prohibited.
New Skies Agent Configuration
The New Skies Credentials agent credentials are usually sent by your TUI Business Partner. For any question about NewSkies credentials, feel free to reach out to user.flightproduction@tui.com
USING THE NEW SKIES DIGITAL API
When all the previous requirements are met, please continue reading on the Get started page to learn how to make use of the Digital API.
Contact
For any further question, please reach out to api.flightproduction@tui.com.
