Introduction🔗

Textkernel's Portal (TK Portal) enables integrations between various Textkernel products and any third-party system by means of Single Sign-On (SSO) schemes and user mapping. It is used for supported integrations (e.g. Bullhorn, SAP, Salesforce), as well as corporate and staffing customers who wish to integrate Textkernel technologies within their systems.

This technical documentation provides general information about the TK Portal REST API and specific information about each API operation and supported entity type, as well as instructions on how to integrate TK Portal for various use cases.

Minimum steps to integrate TK Portal🔗

Step 1: UI integration🔗

TK Portal can be opened in a stand-alone browser window, or it can be embedded in an iframe. Refer to UI integration of TK Portal for more details.

Step 2: Data segregation🔗

In cases where multi-tenancy, or separation of the visibility of documents based on user privileges are needed, Search Policies must be configured. Refer to Data segregation using Search Policies for more information.

Step 3: Authentication🔗

TK Portal can only be accessed by means of Single Sign-On. TK Portal currently offers two industry standards for this purpose:

Step 4: User offboarding🔗

TK Portal offers a full User Management API. The minimum requirement for integrating parties is to set up user offboarding.