Authentication ensures only authorized users can access your knowledge base content through the API. Helpjuice provides API Tokens to manage access for both external and internal content.

In this article, you’ll learn:

• When an API Token is required
• How to authorize guests via API
• How to include the API key in requests
• Troubleshooting access issues

When an API Token is Required

• Guests with a valid API Token: Can access both internal and external questions.
• Guests with an invalid API Token: Cannot access the knowledge base at all.

When an API Token Is Not Required

Guests can access external questions only, provided the internal_kb option is not checked.

How to Authorize Guests via API

To allow guests to access internal questions:

1. Enable the Require API Token setting at your_account.helpjuice.com/admin/en_US/settings/api_credentials

2. Include your API Key in the request:

• Query Parameter: ?api_key=YOUR_API_KEY

Troubleshooting

• Ensure the correct API key is included in the request header or query parameter.
• Verify that the Require API Token setting matches your intended access rules.
• Guests cannot access internal questions without a valid API Token.

Best Practices

• Keep your API keys secure; do not share them publicly.
• Regularly rotate API keys to maintain security.
• Test access after changing token settings to confirm proper permissions.