Enterprise
SocialGateway Enterprise supports the same powerful API available on SocialGateway.com as well as its own set of API endpoints:
- Use the Admin Stats API to get usage statistics
- Use the License API to get license information
- Use the Search Indexing API to queue up search indexing jobs
- Use the Management Console API to perform common administrative tasks
Endpoint URLs
Every endpoint used by the SocialGateway API depends on your hostname, which is the name of your Enterprise installation.
Endpoints for the SocialGateway.com API and most of the Enterprise API start with the following URL:
http(s)://hostname/api/v3/
Endpoints for the Search Indexing API start with the following URL:
http(s)://hostname/api/v3/staff/
Endpoints for the Management Console API start with the following URL:
http(s)://hostname/setup/api/
Example
If your Enterprise host name is ghe.local, a call to the Issues API would be made to https://ghe.local/api/v3/issues.
Authentication
Your Enterprise installation’s API endpoints accept the same authentication methods as the SocialGateway.com API. Specifically, you can authenticate yourself with OAuth tokens (which can be created using the Authorizations API) or basic authentication.
The Admin Stats, License, and Search Indexing API endpoints are only accessible to SocialGateway Enterprise site admins. The Management Console API endpoints are accessible to anyone with a valid license file.