Nodes & Organizations
To use the API you will need to know some basic information about your organization. This will include:
- The node you are on.
- Your organization_KEY.
- Your campaign manager username (email address).
- Your campaign manager password.
- Your headquarters URL.
By taking note of this information from the start you will be fully prepared to troubleshoot problems with the API.
Throughout our documentation you will see URLs like http://sample.nodeurl.tld. Replace this URL with the base portion of your headquarters URL. This could be similar to http://sandbox.salsalabs.org. This references your ACTUAL account. Trying to use your campaign manager with a different node will not work. By default, campaign managers DO NOT have accounts on the sandbox node.
Definitions
- Node - A node within Salsa refers to the specific database that your information is served from. Common node names are org, wfc, org2, etc.
- Organization KEY - A unique number used to identify your organization across Salsa's servers.
- Campaign Manager Username - This is the username used to log into the headquarters for your organization. An organization may have multiple campaign managers. Additionally, campaign managers can be created specifically to provide more granular control.
- Campaign Manager Password - The secret identifier used in combination with a Campaign Manager Username to grant access to Salsa resources for an organization.
- Headquarters URL - The exact address typed into a web browser in order to access the administrative backend (Salsa HQ). For example: https://hq-org.salsalabs.com/salsa/hq/