Retrieve content from Q.wiki process modules via Content API

Modified on Tue, 20 Jan at 11:22 AM

The Q.wiki Content API (currently still in beta) for process modules enables content from the process modules to be queried. Typical use cases include connecting company searches, chatbots, or automated reporting.

The API will be available as a paid add-on option.


Usage of the API


The API allows access to content from process modules, taking into account the permissions of the respective user. Only pages to which you have access will be displayed.


Create authentication token

  • Navigate to User → My profile → Content API
  • Select Add token.
  • Assign a name to the token and define its expiration period.
  • Store the token securely - it is required for all API requests.


Note:

Each user can create tokens with their own permissions.

The complete API documentation can be found in the menu User → Profiles → Integrations under the corresponding link.



 

Important notes on use


    When connecting a company search, it may be useful to create a dedicated dummy user in Q.wiki to control the        desired permissions. This ensures that no sensitive content accidentally appears in the search. 

    The API is in beta status: changes to endpoints and behavior are possible during this time.


Restrictions (details in the technical documentation)


The technical documentation will be available at https://tenant.qwikinow.de/external-api/v1/docs.


    Token creation: Each user can create tokens with their permissions.

    Module filter: Currently does not provide any information about organizational units (OU). 

    (Module IDs: Must be passed as a comma-separated list.) 

    Permissions: Authorized users per page are currently not available via the API (e.g., OAuth). 

    Change suggestions: Changes do not affect the last changed at field. 

    Responsible: Currently only transferred as an ID; separate endpoint planned.

    The contents of file pages cannot currently be queried (separate endpoint planned). 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article