Introduction

Qiscus provides Server API for you to interact with Qiscus data such as, user, chat room, message in your server side, for example you have bot engine that need to send a message in Qiscus Chat SDK, then you can use Server API to do so. You also can do backup, import, and export your data through this API.

API call should use the Base URL on every request and also need Secret Key and App ID in header to able to use the Server API.

Base URL

The format base URL:

https://api.qiscus.com

Example format when calling a endpoint:

https://api.qiscus.com/api/v2.1/rest/create_room

If you are using Qiscus Multichannel, and need create bot with Qiscus Multichannel, you can find the base URL in this link.

Header

The authorization in Server API is using Secret Key and App ID, You can find your App ID and Secret Key on your Qiscus Dashboard and then go to Settings. You can see the picture as a reference.

To use this Server API you need to pass the value through to the headers, the header key for Secret key is QISCUS-SDK-SECRET and App ID is QISCUS-SDK-APP-ID. You can see below an example how to implement the header in cURL:

curl -X POST \

  http://api.qiscus.com/api/v2.1/rest/create_room \

  -H 'Content-Type: application/json' \

  -H 'QISCUS-SDK-APP-ID: sdksample' \

  -H 'QISCUS-SDK-SECRET: 2820ae9dfc5362f7f3a10381fb89afc7' \

  -d '{

  "room_name": "Qiscus Demo Room",

  "creator": "guest@qiscus.com",

  "participants": ["guest@qiscus.com", "guest2@qiscus.com"],

  "room_avatar_url": "http://placehold.it/20x20"

}'