This article describes the Public API on top of Inline Manual profiles data. See documentation for developers for technical details.
Public API is available for Standard PRO and Enterprise plan users.
The Inline Manual API allows for:
* listing user profiles with filtering capability
* creating a single user profile
* case insensitive full-text search across user profiles.
* returning single user profile
* deleting a single user profile
* adding existing tags to a single user profile
* removing some tags from a user profile
* replacing all tags in a user profile
* removing all tags from a user profile
* returning a list of tags
* returning a list of topics assigned to the site
* returning a list of autolaunchers
To validate your requests, you'll need to generate your API token - our system needs to connect all actions you do with your chosen Inline Manual Site. You can generate the API token in the Site's settings.
How to generate an API token
- Go to Site's Settings, then API Access.
- Now, Generate API token.
- Provide a name for your API token. The token name can be 28 characters long.
Check Enabled - this means that the token is active, and you can use it with the API. If you disable it, then it stops working, and the API returns an error. When to disable the token? You can temporarily disable the token, for example for debugging, without a need to deleting it. If you delete a token and create a new one, it will have unique value - different from the previous token.
Check Write access - this means that you can perform all (potentially destructive) operations on top of the data, such as modifying tags on a user profile, deleting, or creating a user profile. If the Write access is not enabled, you can perform only GET operations on top of the API as those are read-data-only ones.
You can use multiple tokens with different configurations for various applications consuming the API. Then you can differentiate what application uses what token, and you can disable or delete only that specific token if, for example, that application is no longer needed. For example, you can have one token for the CRM system with read-only access and different token for some in-house script for tagging users (with Write access).
- Now, copy the token to use it for the authentication.
- Tokens limits depend on your plan. You'll see how many available tokens you have left. Plan limits:
- Standard Pro: Maximum 3 API Tokens
- Enterprise: Maximum 10 API Tokens
- Now, you're ready to create your requests. See documentation for developers for technical details.