Getting Started

Welcome to the Knak developer’s documentation site! Here you will find information on how to get started with building your own integrations with Knak.

This area of the site contains detailed guides and examples for tackling typical integration use cases. To get straight to the definitions of avaliable endpoints and interfaces, see the API Reference section.

For information on how to use Knak for non-developers, see the Knak Help Center.

Interfaces

We break our APIs down into a few key interfaces.

The Knak Enterprise Rest API

This is the core API for interacting with the Knak Enterprise platform, and is most similar to other general purpose REST APIs you may be familiar with. We provide REST endpoints for managing several resources, as well as a Webhooks system for receiving notifications when certain events occur. [API Reference]

Custom MAP Integration

Sync Knak content with your custom marketing automation platform using the Enterprise REST API by following this guide.

Custom Translation Integration

Use the Enterprise REST API to connect to your custom translations pipeline and translate Knak content by following this guide.

SCIM 2.0 API

We provide a SCIM 2.0 API for managing users in your Knak Enterprise account via your Identity Provider (IdP). This API is based on the SCIM 2.0 protocol, which is widely supported by many IdPs. [API Reference]

Pre-defined APIs

To simplify integrations with some common workflows, we provide a few “pre-defined” APIs. These differ from a regular REST API in that they define an interface describing outgoing requests from Knak and the expected responses from your connector.

Custom Validator API

Run Knak Assets through your own validation pipeline and display the results back to Knak Users. [API Reference]

Custom Sync Location API

Use your own logic to determine and restrict the sync location for Knak Assets. [API Reference]

Custom DAM API

Allow Knak Users to add images from your own Digital Asset Management (DAM) system to their Knak Assets. [API Reference]

Live chat

The fastest way to get help when logged into Knak is via the chat icon in the bottom right corner of the screen. Our support team is standing by to answer your questions!