Skip to content

Developer onboarding

Keyword: How do I get started as a SmartTouch developer?

This section takes a new developer from zero to a working remote access session in under 30 minutes. No prior SmartTouch knowledge is required.

You will follow a single guided journey — from getting credentials to opening and closing a live session — using both the stctl CLI and the REST API side by side.

The onboarding journey

Get credentials
      ↓
Generate a token
      ↓
Find a device
      ↓
Verify the device is online
      ↓
Open a remote access session
      ↓
Confirm success
      ↓
Close the session

Each step in First API call shows the stctl command and the equivalent REST API call so you can use whichever fits your workflow.

Onboarding documents

Document What it covers Time
Prerequisites Tools and access you need before starting 5 min
Platform concepts Key terms and how the platform fits together 10 min
Authentication How to get credentials and generate tokens 10 min
First API call The complete 7-step guided journey 20 min
Common errors Errors you may encounter and how to fix them Reference

Recommended order: Read Prerequisites and Platform Concepts first, then Authentication, then work through First API Call step by step.

What you will be able to do after onboarding

  • Authenticate with the SmartTouch platform using both stctl and the REST API.
  • List devices and check whether a device agent is online.
  • Open a diagnostics session to a device and confirm it is active.
  • Close the session cleanly.
  • Understand the error codes you will encounter during development.

If you get stuck

After onboarding

Once you have completed the journey, the rest of the developer section is task-based:

Next topic Link
Deploy a service How do I deploy a service?
Connect a physical device Connect a device for remote access
Instrument your service How do I instrument my service?
Manage secrets How do I manage secrets securely?