List Channel API Keys October 7, 2017

Overview

This API call will return a list containing all API keys associated with the specified channel.

API URL

https://api.ubibot.com/channels/CHANNEL_ID/api_keys?action=list&parameters  

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

HTTP Method

GET

URL Parameters

Name Type Required Description
account_key or token_id String Required Specify the account_key from the user account or token_id obtained after login.

Response

200 Success. The message body contains a JSON object containing all the API keys for the specified channel

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

NB The write_key is used to update the channel and its feeds. Each channel has a single write_key.  A read_key allows the channel metadata to be read. Each channel can have up to 10 read_keys.  These will be returned as a list.

Examples

GET https://api.ubibot.com/channels/CHANNEL_ID/api_keys?action=list&account_key=xxxxx-xxxxx-xxxxx-xxxx

The response is a JSON object containing the write_key and the list of read_keys that are available. For example:

{“result”:”success”,”server_time”:”2017-09-04T08:23:16Z”,”write_key”:”XXX5af4b4e43b2xxx30f584XX587″,”read_keys”:[{“read_key”:”5972XXX478bd4xxf3d0X28a9X”,”note”:null,”created_at”:”2017-09-04T05:49:37Z”,”updated_at”:”2017-09-04T05:49:37Z”}]}