URL structure
The URL structure contains a base URL, the version of the API, the community's API key name, and the resource you would like to call.
| URL example |
|---|
https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/{resource} |
Note:
Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see API Access.
The following table describes the URL syntax.
| URL syntax | Description |
|---|---|
https://api.{region}.alida.com
|
The base URL for all requests to the Alida APIs. |
/v1
or
/v2
|
The version of the API you would like to
call. Version
v2 is only available for certain endpoints.
|
/applications
|
The particular grouping of APIs that you
would like to call. This will always be
applications.
|
/{communityAPIKeyName}
|
The name of the community you want to access. The API key name is located in the API setup section of the Alida platform. To access this section, accept the terms and conditions for API access. |
/{resource}
|
The resource you want to call. |
Note: You may need to encode the URL depending on the application you use
to make the API request. For example:
- Unencoded URL:
GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities?q="openedOn>="2016-05-28T00:00:00Z"" - Encoded URL:
GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities?q=%22openedOn%3E=%222016-05-28T00:00:00Z%22%22
For more information, see HTML URL Encoding Reference.