Company API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/

Companies

APIs to onboard and manage company.

Operations

Update company travel content config

Request

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired

Travel content config of a given company

airConfigobject(AirConfig)

Air content config

curl -i -X PUT \
  https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/travel-content-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "airConfig": {
      "fareCategoryFilter": [
        {
          "priority": 1,
          "origin": {
            "value": "string",
            "metadata": {
              "type": "CITY",
              "code": "string"
            },
            "infos": [
              {}
            ]
          },
          "destination": {
            "value": "string",
            "metadata": {
              "type": "CITY",
              "code": "string"
            },
            "infos": [
              {}
            ]
          },
          "fareCategoryOption": [
            {
              "fareCategory": {
                "ngsCategory": "UNKNOWN_NGS_CATEGORY",
                "cabinViewCategory": "UNKNOWN_CABIN_CATEGORY"
              },
              "disabled": true
            }
          ]
        }
      ]
    }
  }'

Responses

OK

Response
No content

Delete company travel content config

Request

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X DELETE \
  https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/travel-content-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content

Updates white label config

Request

This endpoint stores white label config for the company at different entity levels.

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=ORG
Bodyapplication/jsonrequired
companyNamestring
Example: "Spotnana"
colorsobject(ColorWhiteLabelConfig)required

Whitelabel configuration related to colours.

colors.​primarystring
Example: "#D33B47"
colors.​primaryDarkstring
Example: "#D33B47"
colors.​primaryLightstring
Example: "#D33B47"
colors.​primaryPalestring
Example: "#D33B47"
colors.​onPrimarystring
Example: "#D33B47"
colors.​secondarystring
Example: "#D33B47"
colors.​secondaryDarkstring
Example: "#D33B47"
colors.​secondaryLightstring
Example: "#D33B47"
colors.​secondaryPalestring
Example: "#D33B47"
colors.​onSecondarystring
Example: "#D33B47"
colors.​errorstring
Example: "#D33B47"
colors.​errorDarkstring
Example: "#D33B47"
colors.​errorLightstring
Example: "#D33B47"
colors.​errorPalestring
Example: "#D33B47"
colors.​onErrorstring
Example: "#D33B47"
webLinksobject(WebLinksConfig)

Weblinks which are parts of WhiteLabelConfig.

fromEmailAddressstring
Example: "no-reply@spotnana.com"
fontFamilystring
Default "Arial"
Example: "Arial"
emailFontFamilystring
Default "Roboto"
Example: "Roboto"
fontFamilyCssstring
Example: "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css"
emailClientConfigobject(EmailClientConfig)

Email client configuration representing the email provider to be used.

clientRoutingBasePathstring

Base path used by Spotnana OBT application to invoke API calls. Default path value is /

routingConfigobject(RoutingConfig)

App routing configuration.

privacyDisclaimerobject(PrivacyDisclaimer)

Html to shown on the the login page. This will be text with hyper links.

logoConfigobject(LogoConfig)

Logos to be shown on various parts of the app

curl -i -X PUT \
  'https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/white-label-config?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyName": "Spotnana",
    "colors": {
      "primary": "#D33B47",
      "primaryDark": "#D33B47",
      "primaryLight": "#D33B47",
      "primaryPale": "#D33B47",
      "onPrimary": "#D33B47",
      "secondary": "#D33B47",
      "secondaryDark": "#D33B47",
      "secondaryLight": "#D33B47",
      "secondaryPale": "#D33B47",
      "onSecondary": "#D33B47",
      "error": "#D33B47",
      "errorDark": "#D33B47",
      "errorLight": "#D33B47",
      "errorPale": "#D33B47",
      "onError": "#D33B47"
    },
    "webLinks": {
      "logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
      "logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "companyWebsiteAddress": "https://www.spotnana.com",
      "homePage": "https://stage-app.spotnana.com/flights",
      "itineraryPage": "https://stage-app.spotnana.com/trips/3375488451",
      "disclaimerPage": "https://www.spotnana.com/terms",
      "privacyPage": "https://www.spotnana.com/privacy-policy",
      "hardApprovalUrl": "https://stage-app.spotnana.com/hardapproval?approvalId=CgozMzQ5OTI4MzI2EiMKIQoMCgpQaWh1IEd1cHRhEhFwaWh1QHNwb3RuYW5hLmNvbQ%3D%3D&approverName=Pihu%20Gupta&travelerName=Pihu%20Gupta&tripName=TESting%201&tripId=2418132231&voidDate=Tuesday,%2021%20Jun%20at%2002:00%20UTC",
      "itineraryFlightStatsUrl": "https://stage-app.spotnana.com/trips/4694735622",
      "appEmbedScriptUrl": "https://customjs.partner.com",
      "logoNavigationLink": "http://www.spotnana.com",
      "illustration": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "poweredBySpotnana": false,
      "logoutRedirectUrl": "https://www.spotnana.com/signout",
      "faviconUrl": "http://www.spotnana.com",
      "appDownloadLinks": {
        "androidPlayStoreUrl": "https://play.google.com/store/apps/details?id=com.spotnana",
        "iosAppStoreUrl": "https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446",
        "qrCodeUrl": "https://www.spotnana.com"
      },
      "socialMediaLinks": {
        "facebookUrl": "https://www.facebook.com/spotnanaofficial",
        "twitterUrl": "https://twitter.com/spotnana",
        "instagramUrl": "https://www.instagram.com/spotnana_official"
      },
      "termsOfUse": "https://www.spotnana.com/terms/",
      "illustrationActionUrl": "https://www.spotnana.com/login",
      "checkoutCoverImageUrl": "https://duploservices-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png"
    },
    "fromEmailAddress": "no-reply@spotnana.com",
    "fontFamily": "Arial",
    "emailFontFamily": "Roboto",
    "fontFamilyCss": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css",
    "emailClientConfig": {
      "client": "SENDGRID",
      "credentials": {
        "emailClientSecretKey": {
          "secretKey": "SECRET_KEY",
          "versionId": "1"
        }
      },
      "defaultSenderAddress": "test@somedomain.com",
      "defaultSenderName": "Test Sender"
    },
    "clientRoutingBasePath": "string",
    "routingConfig": {
      "appHomeRoute": "/my-account"
    },
    "privacyDisclaimer": {
      "show": true,
      "html": "</html>"
    },
    "logoConfig": {
      "logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
      "logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "faviconUrl": "http://www.spotnana.com",
      "thumbnailImage": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png"
    }
  }'

Responses

OK

Response
No content

Cost Centers

APIs to create and manage company cost centers.

Operations

Offices

APIs to create and manage company offices.

Operations

Departments

APIs to create and manage departments.

Operations

Service Charge Plan

APIs to manage service charge plans.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations