https://github.com/travelport-ukraine/uapi-json
Best Travelport Universal API wrapper ever :airplane: :mountain_railway: :hotel:
https://github.com/travelport-ukraine/uapi-json
airplane hotel json travelport uapi
Last synced: 5 months ago
JSON representation
Best Travelport Universal API wrapper ever :airplane: :mountain_railway: :hotel:
- Host: GitHub
- URL: https://github.com/travelport-ukraine/uapi-json
- Owner: Travelport-Ukraine
- License: mit
- Created: 2016-07-15T08:25:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-17T18:53:50.000Z (8 months ago)
- Last Synced: 2025-05-16T11:11:23.134Z (5 months ago)
- Topics: airplane, hotel, json, travelport, uapi
- Language: JavaScript
- Homepage: https://travelport-ukraine.github.io/uapi-json/
- Size: 3.62 MB
- Stars: 75
- Watchers: 16
- Forks: 63
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Description
[](https://travis-ci.org/Travelport-Ukraine/uapi-json)
[](https://codecov.io/gh/Travelport-Ukraine/uapi-json/branch/stable)
[](https://www.npmjs.com/package/uapi-json)
[](https://travis-ci.org/Travelport-Ukraine/uapi-json)
Best Travelport Universal API wrapper ever :airplane: :mountain_railway: :hotel:
Wrapper for [Travelport Universal API](https://developer.travelport.com/app/developer-network/universal-api).
Read [official docs](https://support.travelport.com/webhelp/uapi/uAPI.htm) for more information.
Travelport Universal API offers an array of travel content for air, hotel, car, and rail, including ancillaries (optional services). It also provides functionality to build complete traveler, agency, branch, and account profiles.
This package provides JSON/Promises interface for SOAP calls. Requires uAPI credentials to run.
# Contents
* [Installation](#installation)
* [Basic usage](#usage)
* [Settings](#settings)
* [Services](#services)
Install package with `npm install --save uapi-json`.
This package exports an object with three service constructors.
```javascript
const uAPI = require('uapi-json');
const AirService = uAPI.createAirService(settings);
const HotelService = uAPI.createHotelService(settings);
const UtilsService = uAPI.createUtilsService(settings);
const TerminalService = uAPI.createTerminalService(settings);
```
It also exports a set of error classes that help to check errors against them
```javascript
const uAPI = require('uapi-json');
const settings = { auth: {username: 'USERNAME', password: 'PASSWORD', region: 'REGION'}};
const AirService = uAPI.createAirService(settings);
AirService.importPNR().catch((err) => {
if (err instanceof uAPI.errors.Common.ValidationError) {
console.log('Validation error occured');
}
if (err instanceof uAPI.errors.Request.RequestValidationError) {
console.log('Validation error occured in request');
}
if (err instanceof uAPI.errors.Request.RequestValidationError.ParamsMissing) {
console.log('Params are missing for request');
}
});
```
As the [`node-errors-helpers`](https://github.com/Travelport-Ukraine/errors-helpers) library used for error generating,
we strongly recommend you to take a look at it.
It also has several useful helpers to handle errors.
## uAPI
* `.createAirService(settings)` ⇒ [`AirService`](docs/Air.md)
* `.createHotelService(settings)` ⇒ [`HotelService`](docs/Hotels.md)
* `.createUtilsService(settings)` ⇒ [`UtilsService`](docs/Utils.md)
* `.createTerminalService(settings)` ⇒ [`TerminalService`](docs/Terminal.md)
### Settings object
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| auth | `Object ` | - | See `auth` description [below](#auth). |
| debug | `Number` | `0` | Can be `0`, `1`, or `2`. |
| production | `Boolean` | `true` | Production variable is connected with production and pre-production environment. Can be true for production and false for pre-production. For more information read docs. |
| timeout | `Number` | - | Optional. Used for `TerminalService` only. See [`TerminalService`](docs/Terminal.md) |
| autoClose | `Boolean` | Optional. Used only in `TerminalService`. Defines if service should make `closeSession` request. |
| options | `Object` | {} | Optional. User for all services to all additional options like custom log function, etc. See `options` description [bellow](#options). |
`logFunction` - set custom logging function that should match next shape `(...args) => {}`. Will receive all requests and responses from uapi/terminal.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | `String` | - | User name identifier, provided by Travelport. |
| password | `String` | - | Password for current username, provided by Travelport. |
| targetBranch | `String` | - | Branch, provided by Travelport. |
| region | `String` | `emea` | Optional. Used to select region. |
| emulatePcc | `String/Boolean` | `False` | Optional. A PCC on behalf of which transactions are executed in Air, Hotels, Utils. This PCC needs to have set SVCB field in the AAT profile. Define a PCC if you have a service bureau and want to execute transactions on behalf of some of its PCCs. Follow this [documentation](docs/Terminal.md#emulatePcc) to take a detailew view of the `emulatePcc` for the Terminal. |
| provider | `String` | `1G` | Optional. Obtains data directly from specific provider. Be aware, the default provider is `1G`, we never tested any other providers, **use this option at your own risk**.
There are 3 types of `debug` mode:
* `debug=0` - disabled any logs.
* `debug=1` - logging only request params, request xml and error if it's occurred.
* `debug=2` - same as 1 but also logging all response xml (due to lot of text to log).
* `debug=3` - logs everything.
# Services
See the following services pages to take a detailed view
* [`AirService`](docs/Air.md)
* [`HotelService`](docs/Hotels.md)
* [`UtilsService`](docs/Utils.md)
* [`TerminalService`](docs/Terminal.md)
# Contributing
Please visit [CONTRIBUTING.md](/CONTRIBUTING.md)