Manage Help Center API Clients and Platform Connections - Article
Summary
A connected Knowledge Base can support more than a standalone article website. Authorized applications can use the Help Center’s API capabilities, while connected LMS platforms establish the reader and publication context.
These are technical administration responsibilities. Keep API client credentials, platform registrations and role mappings distinct from editorial article audiences, and agree the intended integration before creating access.
Use this article to:
- Distinguish Help Center APIs from the LMS API
- Prepare and protect an appropriately scoped client
- Understand connected platforms, role mapping and technical handover
Choose the right integration boundary
Use the Help Center’s API configuration for Help Center content or its public assistant route. Use the LMS API for LMS business records and workflows. A Help Center API client is not an LMS API client and does not itself enroll learners, manage Training Activities or retrieve all Course and Resource Library information.
For LMS business-record integrations, start with Plan an API Integration and Create and Govern an API Client. Their LMS API instructions are separate from the Help Center client procedure below.
Before setup, define the consuming application, the reader experience, the content it needs and the person who will maintain the connection. Agree the supported integration with Eurekos, including any optional services, rather than assuming every external website or knowledge source is enabled automatically.
Create a Help Center API client
Sign in as a Help Center administrator and open Settings → API clients. The list supports creating and deleting clients; it is not an edit-in-place configuration for existing credentials.
| Control or value | Meaning and handling |
|---|---|
| Name | Use a recognizable application and purpose so ownership is clear |
| Web scope | Supports the Help Center content route for the consuming integration |
| Assistant (public) scope | Supports the public assistant integration route; it is not a way to expose restricted internal knowledge |
| Client ID | Identifies the created client for the supported OAuth2 connection |
| Client secret | Displayed only when the client is created; store it securely at that point |
| Token connection details | Use the exact endpoint, grant and scope values provided for the configured Help Center service |
- Agree the integration purpose and required scope with its technical owner.
- Select Create, enter a meaningful name and select only the scope needed for that integration.
- Submit the client only when its owner is ready to capture and securely store the credentials. The secret is shown once.
- Complete the OAuth2 integration using the service-specific technical connection details and verify the permitted operation.
- Record ownership and the supported retirement or replacement process without copying the secret into an article, screenshot or support conversation.
Keep the client secret in a secure server-side configuration or approved secret store. Do not place it in public web-page code or a reusable training example. Opening the Create form is a preparation step; submitting it creates persistent credentials.
If a client must be replaced, plan the cutover with the application owner, verify the replacement and retire the obsolete client deliberately. Deleting a client can stop the connected application. Existing clients cannot be edited in place, and the secret cannot be viewed again after creation.
Configure the OAuth2 token request
Configure your OAuth2 client with the values below. Use the base address of the Help Center environment the application is intended to connect to. In a client such as Postman, choose a recognizable token name and use Get New Access Token to request the token.
| OAuth2 setting | Value |
|---|---|
| Authorization type | OAuth 2.0 |
| Grant type | Client Credentials |
| Access Token URL | Your Help Center base address followed by /oauth2/token |
| Client ID and Client secret | The credentials of the client created for this integration |
| Scope | web and/or assistant_public, matching the selected client scopes and separated by a space |
| Client authentication | Send as Basic Auth header |
| Authorization data | Request headers |
| Header prefix | Bearer |
For example, a fictional Help Center at https://support.example.org would use https://support.example.org/oauth2/token. The token request authenticates the client using its ID and secret; the resulting access token is sent as a Bearer token for the supported API requests. An invalid or unassigned scope does not become available simply because it is typed into the token request.
Review connected platforms and role mappings
Settings → Platforms lists connected LMS platforms and connection information such as the platform identity, base URL, production status and last update. Use it to identify the intended connected service, not as a substitute for configuring an LMS connection without the appropriate technical coordination.
Platform identity also matters for Release visibility and notification routing. Production Help Centers offer production platform connections for those selections. A platform restriction is different from the article’s Roles selection and different again from an API client’s scope.
Settings → LMS roles maintains the roles offered by the Help Center audience configuration. Coordinate role mapping with the connected LMS and your access owner. Renaming or removing mappings without understanding their article use can change how content is targeted; do not treat the list as decorative terminology.
For ordinary content access decisions, use Connect Your Knowledge Base and Manage Reader Access. For Release-specific platform restrictions, use Publish Help Center Release Updates and Planned Changes.
Hand over a maintainable connection
A technical handover should let another responsible person diagnose the service without rediscovering its purpose. Record the application owner, supported endpoints and scopes, environment, credential-storage location, expected operations and the retirement process. Keep secret values out of the handover document itself.
Use a fictional example such as “Customer support portal — public guidance” in an explanation, but use the actual application name in your private operational records. Keep test and production destinations distinct and verify the intended audience with the consuming application; a successful token request alone does not prove the complete reader experience.
| Scenario or check | Expected result or evidence |
|---|---|
| The client is created | Its purpose and selected scope match the intended integration and credentials are securely captured |
| The consuming application requests the supported operation | The configured OAuth2 connection succeeds with the appropriate content boundary |
| Public assistant access is used | Only knowledge suitable for the public route is exposed |
| A platform-specific Release is prepared | The selected platform identity and visibility rules match the intended production connection |
| A client is retired | The application owner confirms cutover or retirement before the credential is removed |
Troubleshooting
| Problem | What to check |
|---|---|
| The secret is no longer visible | It is shown only at creation; use the agreed secure storage or coordinate a replacement client |
| The API operation fails after token setup | Check the service-specific endpoint, scope, client credentials and response evidence; distinguish Help Center and LMS APIs |
| A platform is missing from a Release selector | Check the connection identity and production status in the intended service |
| An integration stopped after cleanup | Check whether its client or platform connection was removed and coordinate recovery with the technical owner |
| A role is absent from article configuration | Review the connected LMS role mapping with its responsible owner before changing article audiences |
FAQ
-
Is a Help Center API client the same as an LMS API client?
No. The Help Center client supports its own content or public assistant integration. LMS business operations use the separately configured LMS API.
-
Can I view a Help Center API client secret again later?
The secret is displayed only when the client is created. Capture it into an approved secure store at that point. If it is unavailable later, coordinate a replacement rather than assuming it can be recovered from the list.
-
Can I edit an existing Help Center API client in place?
The available client management supports creating and deleting clients. Plan any replacement with the consuming application owner so credential changes do not unexpectedly interrupt the service.