Generate Channel Read-only Key

2017-10-07 11:48:51

Overview


This API call is used to generate a read-only key for a specified user on this channel.

API URL


https://webapi.ubibot.com/channels/CHANNEL_ID/api_keys?action=generate_read_key&parameters

Where CHANNEL_ID is the ID of the target channel and the parameters are as defined below.

HTTP Method


POST

URL Parameters





Name Type Required Description
account_key String Required Specify the account_key obtained from the web console panel.

Response


An HTTP code of 200 is responded for each successful data requests. The message body contains a JSON object containing the new read-only key for the specified channel.

Error: See the separate list of error codes for more details.

Examples


POST https://webapi.ubibot.com/channels/CHANNEL_ID/api_keys?action=generate_read_key&account_key=xxxxxx-xxxxxx-xxxxxx-xxxxx
{"
result": "success",
"server_time": "2017 - 09 - 04 T08: 59: 30 Z",
"read_key": "9 b11Xxxx5XbacbXa0e8dd53″
}