- Previous: HighFlyer
- Up: HighFlyer
- Next: Destination
HighFlyer
## Content
- [Postman collection](#postman-collection)
- [API Description](#api-description)
- [API Parameters](#api-parameters)
- [HTTP Headers](#http-headers)
- [Input ](#input-parameters)
- [Output ](#output-parameters)
- [Error Codes](#error-codes)
## Postman collection
Please download the postman collection environment and request for API Key to get started.
HighFlyer API Collection- Local playground with examples of request/response pairs for each endpoint. Additionally it assist the developers to understand the logical flow for the endpoints.
HighFlyer API Environment- Holds the credential information that allows invocation of the endpoints. You can request for the credentials for this specific API [here](/apps/myapps).
Request for API key
## API Description
| | |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| API Name | highflyer/createlead |
| API Type | Query | | API Source | Eretail |
| Description | SIA KrisConnect team has developed a HighFlyer Registration API to allow SIA partners to facilitate HighFlyer member registration in their channels.
Singapore Airlines HighFlyer is a corporate travel programme for the Small and Medium-sized Enterprises (SME). In HighFlyer, companies earn HighFlyer points while the travellers continue to earn KrisFlyer miles. The points earned can be used to pay for future trips or redeemed for Scoot vouchers. More information can be found on here. | ## API Parameters ### HTTP Headers | Headers | Value | Description | | ------------------ | --------- | ---------------------------------------------------------------------------- | |Content-Type|application/json|| |api_key|*|An active SQ API Key for the High Flyer Package| |x-signature|*|(ApiKey + Secret + TimeStamp) HMAC-SHA256| |x-csl-client-uuid|*|Should be unique per request. For debug purpose only.| ### Input Parameters | | Input Parameters | | Data Type | Description | | --------- | -------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------- | | company | | | JSON Object | | | | name | | String | Company name, e.g. Singapore Airline | | | employeeStrength || String Enum | Company size. There are 3 options: "1-50", "51-100", "More than 100". | | | phoneNumber | | String | Company phone number, e.g 65-12345678 | | | mobileNumber | | String | Company mobile number, e.g 65-87654321 | | | address | | JSON Object | | | | | line1 | String | Address line 1 | | | | line2 | String | Address line 2 | | | | city | String | Company city town, e.g. NYC | | | | stateCode | String | Company state town, e.g. CA | | | | countryCode | String | Company country town, e.g. US | | | | postalCode | String | Company postal code, e.g. 123456 | | | currencyCode | | String | Currency code, e.g. SGD | | | budgetRange | | String | Company budget, e.g. 10000 | | | website | | String | Company website, e.g. http://testcompany.com | | | registrationNumber | | String | Company registration number, e.g. REGN12345678 | | emailModePreferred | | | Boolean | Whether customer is comfortable being contacted via Email. | | newsSubscription | | | Boolean | Whether customer would like to subscribe to SQ News. | | phoneModePreferred | | | Boolean | Whether customer is comfortable being contacted via Phone. | | promoSubscription | | | Boolean | Whether customer would like to subscribe to SQ Promotions. | | employee | | | JSON Object | | | | title | | String | Title, e.g. Mr | | | firstName | | String | First name. | | | lastName | | String | Last name. | | | gender | | String | Gender. | | | dateOfBirth | | String | Date of birth, e.g. 1990-01-03. | | | email | | String | Email, e.g test@email.com.sandbox. | | | jobTitle | | String | Job title, e.g. Manager. | | | isEUResident | | Boolean | Whether EU resident. | | | krisflyerNumber | | String | Kris Flyer number, e.g. 8989988890 | | leadSource | | | String | Lead source code, e.g. AGENT1 | ### Output Parameters | Output Parameters | Data Type | Description | | ---------------------- | ------------ | ---------------------------------------------------------------------------------------------------- | | status | String | “SUCCESS” / “FAILED” | | code | Number | 200 if status is “SUCCESS”. Refer to Section 5 for possible error codes | | message | String | Populated and displayed only if status is “FAILED” | ### Error Codes | ErrorCodes | Message | | ---------- | --------------------------------------------------------------------------------------------- | | CSLAAA9904 | clientID is mandatory. | | CSLAAA9905 | The provided clientID is not supported. | | CSLAAA9906 | clientUUID is mandatory. Note: clientUUID should be an unique value for each request. | | CSLAAA9907 | Invalid clientID. Note: A valid clientID should be 3-10 characters and only contains letters, digits, or dash (-). | | CSLAAA9921 | Internal error occurred while trying to look for config values. Please contact the service provider for details. | | CSLAAA9931 | Valid request must be provided. | | CSLAAA9970 | Operation timed out. | | CSLAAA9998 | Unknown error occurs. Please contact the service provider for details. | | CSLAAA9999 | Unknown error occurs. Please contact the service provider for details. | | HFLYAA0000 | Invalid request. | | HFLYAA0100 | The input <%s> is invalid. | | HFLYCR1000 | Invalid company: <%s>. | | HFLYCR1001 | Invalid company->name: <%s>. Only alphabets and spaces are allowed | | HFLYCR1002 | Invalid company->registrationNumber: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1020 | Invalid address: <%s>. | | HFLYCR1021 | Invalid company->address->line1: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1022 | Invalid company->address->line2: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1023 | Invalid company->address->country: <%s>. Expects 2-alpha string | | HFLYCR1024 | Invalid company->address->state: <%s>. Expects 2-alpha string | | HFLYCR1025 | Invalid company->address->city: <%s>. Expects 3-alpha string | | HFLYCR1026 | Invalid company->address->postalcode: <%s>. Only alphabets, numbers, and underscores(_) are allowed | | HFLYCR1030 | Invalid employee: <%s>. | | HFLYCR1031 | Invalid firstName: <%s>. | | HFLYCR1032 | Invalid lastName: <%s>. | | HFLYCR1033 | Invalid dateOfBirth: <%s>. Expected format: yyyy-MM-dd | | HFLYCR1034 | Invalid email: <%s>. | | HFLYCR1900 | Call to create lead timed out. | | HFLYCR1901 | Lead could not be created. | | HFLYCR1902 | Company Registration Number <%s> already exists. |
Singapore Airlines HighFlyer is a corporate travel programme for the Small and Medium-sized Enterprises (SME). In HighFlyer, companies earn HighFlyer points while the travellers continue to earn KrisFlyer miles. The points earned can be used to pay for future trips or redeemed for Scoot vouchers. More information can be found on here. | ## API Parameters ### HTTP Headers | Headers | Value | Description | | ------------------ | --------- | ---------------------------------------------------------------------------- | |Content-Type|application/json|| |api_key|*|An active SQ API Key for the High Flyer Package| |x-signature|*|(ApiKey + Secret + TimeStamp) HMAC-SHA256| |x-csl-client-uuid|*|Should be unique per request. For debug purpose only.| ### Input Parameters | | Input Parameters | | Data Type | Description | | --------- | -------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------- | | company | | | JSON Object | | | | name | | String | Company name, e.g. Singapore Airline | | | employeeStrength || String Enum | Company size. There are 3 options: "1-50", "51-100", "More than 100". | | | phoneNumber | | String | Company phone number, e.g 65-12345678 | | | mobileNumber | | String | Company mobile number, e.g 65-87654321 | | | address | | JSON Object | | | | | line1 | String | Address line 1 | | | | line2 | String | Address line 2 | | | | city | String | Company city town, e.g. NYC | | | | stateCode | String | Company state town, e.g. CA | | | | countryCode | String | Company country town, e.g. US | | | | postalCode | String | Company postal code, e.g. 123456 | | | currencyCode | | String | Currency code, e.g. SGD | | | budgetRange | | String | Company budget, e.g. 10000 | | | website | | String | Company website, e.g. http://testcompany.com | | | registrationNumber | | String | Company registration number, e.g. REGN12345678 | | emailModePreferred | | | Boolean | Whether customer is comfortable being contacted via Email. | | newsSubscription | | | Boolean | Whether customer would like to subscribe to SQ News. | | phoneModePreferred | | | Boolean | Whether customer is comfortable being contacted via Phone. | | promoSubscription | | | Boolean | Whether customer would like to subscribe to SQ Promotions. | | employee | | | JSON Object | | | | title | | String | Title, e.g. Mr | | | firstName | | String | First name. | | | lastName | | String | Last name. | | | gender | | String | Gender. | | | dateOfBirth | | String | Date of birth, e.g. 1990-01-03. | | | email | | String | Email, e.g test@email.com.sandbox. | | | jobTitle | | String | Job title, e.g. Manager. | | | isEUResident | | Boolean | Whether EU resident. | | | krisflyerNumber | | String | Kris Flyer number, e.g. 8989988890 | | leadSource | | | String | Lead source code, e.g. AGENT1 | ### Output Parameters | Output Parameters | Data Type | Description | | ---------------------- | ------------ | ---------------------------------------------------------------------------------------------------- | | status | String | “SUCCESS” / “FAILED” | | code | Number | 200 if status is “SUCCESS”. Refer to Section 5 for possible error codes | | message | String | Populated and displayed only if status is “FAILED” | ### Error Codes | ErrorCodes | Message | | ---------- | --------------------------------------------------------------------------------------------- | | CSLAAA9904 | clientID is mandatory. | | CSLAAA9905 | The provided clientID is not supported. | | CSLAAA9906 | clientUUID is mandatory. Note: clientUUID should be an unique value for each request. | | CSLAAA9907 | Invalid clientID. Note: A valid clientID should be 3-10 characters and only contains letters, digits, or dash (-). | | CSLAAA9921 | Internal error occurred while trying to look for config values. Please contact the service provider for details. | | CSLAAA9931 | Valid request must be provided. | | CSLAAA9970 | Operation timed out. | | CSLAAA9998 | Unknown error occurs. Please contact the service provider for details. | | CSLAAA9999 | Unknown error occurs. Please contact the service provider for details. | | HFLYAA0000 | Invalid request. | | HFLYAA0100 | The input <%s> is invalid. | | HFLYCR1000 | Invalid company: <%s>. | | HFLYCR1001 | Invalid company->name: <%s>. Only alphabets and spaces are allowed | | HFLYCR1002 | Invalid company->registrationNumber: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1020 | Invalid address: <%s>. | | HFLYCR1021 | Invalid company->address->line1: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1022 | Invalid company->address->line2: <%s>. Only alhabets, numbers, hashes(#), underscores(_), hypens(-), quotes('), forward-slashes(/), commas(,) and spaces are allowed | | HFLYCR1023 | Invalid company->address->country: <%s>. Expects 2-alpha string | | HFLYCR1024 | Invalid company->address->state: <%s>. Expects 2-alpha string | | HFLYCR1025 | Invalid company->address->city: <%s>. Expects 3-alpha string | | HFLYCR1026 | Invalid company->address->postalcode: <%s>. Only alphabets, numbers, and underscores(_) are allowed | | HFLYCR1030 | Invalid employee: <%s>. | | HFLYCR1031 | Invalid firstName: <%s>. | | HFLYCR1032 | Invalid lastName: <%s>. | | HFLYCR1033 | Invalid dateOfBirth: <%s>. Expected format: yyyy-MM-dd | | HFLYCR1034 | Invalid email: <%s>. | | HFLYCR1900 | Call to create lead timed out. | | HFLYCR1901 | Lead could not be created. | | HFLYCR1902 | Company Registration Number <%s> already exists. |
- Previous: HighFlyer
- Up: HighFlyer
- Next: Destination