Configuration

Getting Started

Symphony bot clients require a JSON configuration file called config.json that contains configuration information.

This JSON configuration file is generated by the Symphony bot generator. Its format and contents are the same across all implementation languages. The file contains the following information:

  • Session Auth Host and Port
  • Key Auth Host and Port
  • Pod Host and Port
  • Agent Host and Port
  • Bot details
  • Certificate Path and Password

The following shows an example of the configuration file:

{
  "sessionAuthHost": "COMPANYNAME-api.symphony.com",
  "sessionAuthPort": 8444,
  "keyAuthHost": "COMPANYNAME-api.symphony.com",
  "keyAuthPort": 8444,
  "podHost": "COMPANYNAME.symphony.com",
  "podPort": 443,
  "agentHost": "COMPANYNAME.symphony.com",
  "agentPort": 443,
  "botCertPath": "PATH",
  "botCertName": "BOT-CERT-NAME",
  "botCertPassword": "BOT-PASSWORD",
  "botEmailAddress": "BOT-EMAIL-ADDRESS",
  "appCertPath": "",
  "appCertName": "",
  "appCertPassword": "",
  "proxyURL": "",
  "proxyUsername": "",
  "proxyPassword": "",
  "authTokenRefreshPeriod": "30"
}

Note:
sessionAuthHost: Your Pod url in Symphony, used for session authentication.
sessionAuthPort: Port used for session authentication. For cloud deployments, use 8444.

In-Cloud Deployments
In-cloud deployments of Symphony use the following formats:

  • Session Auth URL: COMPANYNAME-api.symphony.com:8444
  • Key Auth URL: COMPANYNAME-api.symphony.com:8444
  • Pod Url: COMPANYNAME.symphony.com:443
  • Agent Url: COMPANYNAME.symphony.com:443

Enterprise deployments
In enterprise deployments of Symphony, the Key Auth URL and the Agent URL are different because the Symphony software is deployed on premise. Contact your Symphony administrator for details. For more information, see Authentication.

Contributing to the SDKs

If you see any missing functionality, or have suggested improvements, we encourage you to consider contributing to our code base.

Symphony SDKs are open-source, which means they are free for you to utilize and to contribute to. We’d also like to continuously improve our SDKs. If you find any bugs or think of ways to improve the Symphony SDKs, please feel free to share them with the Symphony team. You can follow the following simple process to become a contributor:

  1. Fork the Symphony API client repository
  2. Create your developer branch, add your codes, commit, and push
  3. Test your branch and merge with master
  4. Create a Pull Request (PR) on the public repository
  5. The Symphony team will review and either Approve, Request Changes, or Reject your PR
  6. Once approved, your codes will be part of the next minor release (frequency is once a month)

The process is straightforward, so why wait? We welcome you to contribute now!

Updated 5 months ago


What's Next

To learn more about certificates and authentication, click below.

Get Started with Node.js
Get Started with Java
Get Started with .NET

Configuration


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.