For the complete documentation index, see llms.txt. This page is also available as Markdown.

Enable Portal API access

Enable API access in the portal settings and understand what it unlocks.

This page is specifically about giving your Customer Portal's own users API access to their portal data. If you're looking to connect OutSmart to your own software, ERP, or a custom integration, see Authentication instead.

Portal API access lets external systems interact with portal data.

You enable it in the portal settings.

1

Open the portal

Open the portal you want to edit.

2

Open Portal settings

Select Portal settings in the left menu.

3

Enable API access

Turn on Enabled API.

4

Save the settings

Click Save.

5

Review access controls

Check the authentication and integration setup you want to use.

When to use this

Use API access when another system needs to read or submit portal data.

Frequently asked questions

Where do I enable API access?

In Portal settings.

Does API access require extra setup?

Usually yes.

You also need the right authentication and integration setup.

Should every portal enable API access?

No.

Only enable it when you need an integration.

Last updated

Was this helpful?