Applications
An application configures the set of ChatKitty resources related by an application ID and API key.
A ChatKitty application is needed to create users, channels, messages, etc. and interact with ChatKitty on behalf of your app.
note
If you have multiple deploy environments like development, staging, production, etc., we recommened a application per environment to isolate data.
Schema
id required | integer <int64> 64-bit integer identifier associated with this resource |
key required | string Primary API key assigned to this application |
required | object Custom properties attached to this application |
createdTime required | string <date-time> ISO date-time this application was created |
object (Links) |
{- "id": 1,
- "name": "Rockstar App",
- "key": "19b458d0-2b50-491c-8f13-65ec12f3978e",
- "properties": { },
- "createdTime": "2020-10-02T20:29:25.316Z",
- "_links": {
- "users": {
- "templated": true
}, - "channels": {
- "templated": true
}, - "pushNotificationCredentials": {
}
}
}
Creating an application
Create an application using the ChatKitty dashboard.
Application OAuth V2 credentials
ChatKitty expects a valid OAuth V2 Bearer access token issued on behalf of an application, using the client credentials flow to be included in all API requests related to the application.
Retrieve the OAuth V2 client ID and client secret needed to issue access tokens from the Dashboard, from the settings page.
Retrieving the authenticated application
To get the application authenticated, use the Platform REST API:
curl 'https://api.chatkitty.com/v1/application' \
-H "Authorization: Bearer OAUTH-TOKEN"
Retrieve application by ID
To get an application by ID, use the Platform REST API:
curl 'https://api.chatkitty.com/v1/applications/APP-ID' \
-H "Authorization: Bearer OAUTH-TOKEN"
Retrieving application settings
To get the current setting for an application, use the Platform REST API:
curl 'https://api.chatkitty.com/v1/applications/APP-ID/settings' \
-H 'accept: application/hal+json' \
-H 'Authorization: Bearer OAUTH-TOKEN'
Update application settings
You can change your application's configuration, for example, changing guest user authentication, using the Platform REST API:
curl -X PUT 'https://api.chatkitty.com/v1/applications/APP-ID/settings' \
-H 'accept: application/hal+json' \
-H 'Authorization: Bearer OAUTH-TOKEN' \
-H 'Content-Type: application/json' \
-d '{"guestUsers":"DISABLED"}'
Deleting an application
You can delete an application using the Platform REST API:
curl -X DELETE 'https://api.chatkitty.com/v1/applications/APP-ID' \
-H "Authorization: Bearer OAUTH-TOKEN"
warning
Deleting an application deletes all data associated with the application including users, channels, messages and call histories. Only delete an application if you are sure you no longer need all resources associated with it.