Toon API terminology

Access_token: For most API calls, you need an access token. You can obtain an access token using an API call, see the API walkthrough.  

Key: Each developer or app has a key that looks like this: “9ifidpSS9LsNsc3SBg_kVBrnl1Ya”. You must use the key to make API calls. Most keys can only be used for testing on Virtual Toons, only some keys (production keys) can be used for all Toons. The key is the same as a client_Id.

Password: There is a password for each username that is used for logging in to toonapi.com.  

Secret: Each key has a secret, that acts as some kind of password to add additional security. It looks like this: fyxmAUWzTEIolSE4xwwxnv0DGsIa . You typically provide the secret together with the key. A client_secret is the same as secret.

State: There are four states: 0 = Comfort, 1 = Home, 2 = Sleep, 3 = Away.

Username: An email address of an owner of a Toon device. Using the username and password, you can ask for the access token a device.  An example username is “Toon21@quby”. The password for this example username is “Password”.

Types of Toon devices

Virtual Toon: Each developer that registers at www.toonapi.com receives access to a Virtual Toon. This device only exists on a server and responds to API calls in a way similar to a real Toon device. It is used for testing

Field test Toon: Some users (mostly Toon employees) have a Toon device that can be connected to not-yet-published apps. These Toons are used for testing apps before they receive an official API key.

Production Toon: A production Toon is a normal Toon device that is owned by most consumers. Apps can only connect to production Toons after they have been tested and reviewed.

Image credit: Alex Read unsplash