Skip to content

General

Overview

Interaction designer HTTP API

Interaction Designer provides a REST API over HTTP is available at https://interactiondesigner.giosg.com/.

Prerequisites

Before you can use Interaction Designer HTTP API, you need to have an active Giosg account. Additionally it is beneficial if you are familiar with Giosg Interaction Designer and have at least created one interaction created.

Authentication

The Interaction Designer HTTP API can be used with both an API token or via an OAuth2 access token. The Interaction Designer API endpoints require you to have the Interaction Designer feature enabled in your subscription.

Once you have obtained your API token, define the Authorization HTTP header for your API request to use it. Note that "token word" should be Token when using API token and Bearer when using OAuth2 access token.

Example of using API Token authentication:

1
Authorization: Token <api token>

Example of using OAuth token authentication:

1
Authorization: Bearer <access token>