API credentials
The APIs tab on the Integrations screen provides API documentation and credentials information required for authentication and operations.
APIs
This section of the Integrations screen provides documentation links to the:
-
Developer documentation for general information about Springboard APIs and developer tools.
-
Authentication API to obtain the token to run queries in other Springboard APIs.
-
Query API to perform search and other types of queries in Springboard APIs. In addition to the credentials, use the scope value of
connectedsearch.queryto generate the authentication token. -
Push API to push structured data to Springboard to make it searchable. In addition to the credentials, use the scope value of
datasource.pushto generate the authentication token.
Credentials
The following values are used to obtain authentication tokens and values sent in API queries:
-
Customer ID. The unique Springboard value that identifies your organization.
-
Application ID. The unique Springboard value that identifies a specific application. Each application has a different value.
-
Client ID. The unique client value that is part of the information required to obtain OAuth 2.0 authorization.
-
Client Secret. The private client value that is part of the information required to obtain OAuth 2.0 authorization. You must keep this value secret. Do not use it in public clients such as client-side applications.
Contact Lucidworks Support if you need to regenerate your client secret.
Additional information
For information about:
-
Springboard API authentication, see Authentication API.
-
Performing Springboard Connected Search Query API requests, see Query API.
-
Performing Push API requests, see Push API.