Authentication

Issue and manage API Keys for Open API

The resources in the Documents feature are managed under a Space. Follow the user guide and create an API Key issued from the Space Settings menu. The API Key can be used to access any resources under the space, but cannot be used to access articles or other entities under other spaces.

After issuing an API Key, you should store the generated access key and access secret. You cannot view the access secret once you complete creating a new API key. The access key and secret should be stored securely since it can be used to access any resources and documents (even unpublished ones) in the space.

If you remove an API Key, the access key and secret from the removed key will be revoked immediately.

How to authenticate to Documents REST API

Once you have a access key and secret, it can be used for authenticating to REST API. The key and secret should be provided with Basic authentication as follows:

curl -X GET \
	https://document-api.channel.io/open/v1/spaces/$me \
  -H 'Authentication: Basic <credentials>' \
  -H 'Accept: application/json'

<credentials> should be a base64 encoding of <access_key>:<access_secret>.