Skip to content
Matej Sychra edited this page Jun 22, 2017 · 12 revisions

Welcome to the thinx-device-api wiki!

This is second commit in order to start some documentation besides installation records for test server at http://thinx.cloud.

There are several things in need of documentation now, because there are takeovers between different platforms/environments/interfaces.

User Manual

Tutorials

  1. Create account
  2. Get API Key
  3. Check out platform library and insert API Key
  4. Register the device
  5. Observer, attach, rebuild, update, notify...

Remote Things Management (RTM) Console Overview

DASHBOARD

List of all your devices incl. last checkin time, firmware version, etc.

API KEYS

Those are access keys for you and your devices. You can create as many keys as you like, preferably one per device. Most of the activities on API will be based on those access keys. Future ACL hierarchy extension is expected. Per-build API Key rotation feature is coming soon.

SOURCES

Add your GIT repositories with sources. In case the repositories are private, add a key in the RSA Keys section to access them securely.

RSA KEYS

Add your RSA keys for secure read-only access to your private git repositories.

ENVIROS

Key-value based environment strings you define will be injected as variables to your source-code of the language you prefer. You can use this to inject SSID and PASSWORD of your WiFi (and even API Keys will be done like this soon) in case you don't want to store those in the GIT repository (e.g. your repo is public).

USER PROFILE

Personal details. Nobody expects those to be true. Your account is activated based on e-mail and that's enough. You can use any name, any avatar, nobody cares and all the data are kept as secure as possible anyway, because that's how we do it.

However, it enables you to enter your phone number and get in touch with us directly as a developer. Additionaly it provides Notification settings (we don't send any notifications at all, but seriously, we need a consent in case we'd actually need to do that).

Clone this wiki locally