• Home>
• Guide>
• Using the API

Using the API

URL structure

All calls to our API has the format below. All communications are securely encrypted with HTTPS using SSL/TLS. Before you can use the API you need to create an Induct API app.

https://api.induct.no/{apiVersion}/{clientId}/{resource}/{parameters}

{apiVersion}

Indicates the version of the API. (eg. v1)

{clientId}

This is your API application id/key. It is used to identify your application against our system.

{resource}

See complete list of resources in our resource overview page

{parameters}

The various available parameters for each resource can be found in the API doc

Authentication

If your app has not enabled anonymous access, then all requests to the API needs to include the access token.
You retrieve a valid access token from the login process, (returned by Induct login).
This access token can either be sent by a query string parameter: "access_token".

Example:
https://api.induct.no/v1/4tn0w5kjjzak/initiatives/ideas?access_token=MxTjj7LNcl0aVOgSliSccN7bwaPKpGs_b_gONfq2ksI1

Or you can use the Authorization header. Example:
Authorization: Bearer MxTjj7LNcl0aVOgSliSccN7bwaPKpGs_b_gONfq2ksI1

XML/JSON response formats

The Induct API supports content negotiation. To control what response format you get back set the Accept or Content-Type request headers. For example:

Accept: application/json.

Fetch

When retrieving data from the API some objects are "trimmed" down, not all properties are filled with data by default. This is introduced to reduce the amount of data by only fetching the most important properties of each object.
To override what properties are filled you can use the query parameter "fetch". The parameter value is a comma seperated list of properties.

Example: (fetch createdby and comments)

https://api.induct.no/v1/4tn0w5kjjzak/initiatives/ideas/?fetch=createdby,comments

Example:

https://api.induct.no/v1/4tn0w5kjjzak/initiatives/ideas/?fetch=stage,createdby.profileimage.content,comments.createdby.profileimage.content,comments.subcomments.createdby.profileimage.content

Paging

To retrieve partial datasets you may use the pagination feature to decide how many rows to retrieve and what row to start at.
Example: (get a maximum of 3 ideas, starting at the sixth idea among all ideas)

https://api.induct.no/v1/4tn0w5kjjzak/initiatives/ideas?limit=3&offset=6