Jump to Content
Things5
HomeGuidesAPI ReferenceChangelog
Log InThings5
API Reference
Log In
HomeGuidesAPI ReferenceChangelog

Introduction

  • Getting Started
  • FAQ
  • Glossary
  • Firewall
  • Permissions

HTTP API

  • General parameters
  • Authorization
    • Get access tokenpost
    • Refresh tokenget
    • Token exchangepost
  • Organization
    • Listget
    • Detail Organizationget
    • Update organizationpatch
    • Logo and favicon updateput
  • Device
    • [DEPRECATED] Device listget
    • Device listget
    • Device detailsget
    • Device createpost
    • Device provisioning V1put
    • Device provisioning V2put
    • Change machine modelpost
    • Device updatepatch
  • Device Model
    • Device models listget
    • Device model detailget
  • Device Firmware
    • Device firmwares listget
    • Device firmware update requestpost
    • Device firmware detailget
  • Device Data
    • Data ingestionpost
    • States readget
    • States read last valueget
    • Metrics readget
    • Aggregated metricsget
    • Events readget
    • Parameters readget
    • Parameters writepost
  • Device Groups
    • Categories
      • List device group categoriesget
      • Create machine group categorypost
      • Edit device group categorypatch
      • Delete device group categorydelete
    • Groups
      • Createpost
      • Listget
      • Deletedelete
      • Showget
      • Updatepatch
    • Device-Group association
      • Deletedelete
      • Createpost
    • Users
      • Create user-device group associationpost
      • Remove user-device associationdelete
  • HACCP
    • HACCP deviceget
    • HACCP email notification detailget
    • HACCP email notification updatepatch
  • Diagnostic Dashboard
    • Diagnostic dashboard listget
    • Diagnostic Dashboard updatepatch
    • Diagnostic Dashboard deletedelete
    • Diagnostic Dashboard socket
  • Users
    • User updatepatch
    • Current user updatepatch
    • User createpost
    • Users listget
    • Users detailget
  • Overview
    • Alarmsget
    • Eventsget
  • Notes
    • Notes listget
    • Notes createpost
    • Notes deletedelete
  • Roles
    • Roles listget
    • Roles createpost
    • Edit Rolepatch
  • Knowledge base
    • Get Upload images linkget
    • Create new documentpost
  • Plans
    • Plans
      • Plans detailget
      • Plans createpost
      • Plans Updatepatch
      • Plan deletedelete
      • Plans listget
      • Set default planpost
      • Set fallback planpost
    • Emails
      • Emails listget
      • Email createpost
      • Email updatepatch
      • Audience detailget
      • Audience upsertput
    • Machine plans
      • Batch upsert machines planput
      • Upsert machine planput
  • Event notifications
    • List event notificationsget
    • Event notifications updateput

HTTP API Recipes

  • Intro
  • Things5 managed Recipes
    • Init recipesget
    • List recipesget
    • Recipe detailget
    • Delete recipedelete
    • Update recipepatch
    • Create recipepost
  • Device managed recipes
    • Read recipesget
    • Read recipeget
    • Write recipepost
    • Delete recipedelete
  • Cookbooks & recipe templates
    • Recipe template listget
    • Recipe template deletedelete
    • Recipe template createpost
    • Recipe template detailget
    • Recipe template add to cookbookpost
    • Cookbook listget
    • Cookbook detailget
    • Cookbook deletedelete
    • Cookbook-recipe-template, deletedelete
    • Cookbooks sync listget
    • Cookbook sync detailget
    • Cookbook sync requestpost
    • Cookbook sync log retryget

MQTT API

  • Introduction
  • [Pub] Data ingestion request
  • [Sub] Data ingestion response
  • [Sub] Realtime monitoring request

MQTT API - Configuration Parameters

  • Introduction
  • [Sub] Parameters read request
  • [Pub] Parameters read response
  • [Sub] Parameters write request
  • [Pub] Parameters write response
  • [Pub]Variables changed request
  • [Sub]Variables changed response

MQTT API - Firmware

  • [Sub] Update request
  • [Pub] Update response
  • [Pub] Update progress
  • [Evt][Pub] Firmware version request
  • [Evt][Sub] Firmware version response
  • [Req][Pub] Firmwares list request
  • [Req][Sub] Firmwares list response
  • [Req][Pub] Firmware details request
  • [Req][Sub] Firmware details response
  • Introduction

MQTT API - HACCP

  • Introduction

MQTT API - Recipes

  • Introduction
  • [Sub] Read recipes request
  • [Pub] Read recipes response
  • [Sub] Write recipe request
  • [Pub] Write recipe response
  • [Evt][Pub] Recipes updated manually
  • [Sub] Delete recipe request
  • [Pub] Delete recipe response
  • [Sub] List recipes request
  • [Pub] List recipes response
  • [Sub] Read recipe request
  • [Pub] Read recipe response
  • [Sub] Sync recipe templates request
  • [Pub] Sync recipe templates response

MQTT API - Logs

  • [Pub] Log ingestion request
  • [Sub] Log ingestion response

MQTT API - MISC

  • [Req][Pub] Model change request
  • [Req][Sub] Model change response
  • [Pub] Start VPN
  • [Pub] Stop VPN

MQTT API - Token Exchange

  • Introduction
  • [Pub] Token exchange session request
  • [Sub] Token exchange session response
  • [Sub] Token exchange response
Powered by 

Authorization

Things5 uses keycloak as authentication server, which leverages OIDC as authentication protocol. It is possible to use a OIDC library to manage token authentication and refresh for you, like https://www.npmjs.com/package/oidc-react or https://github.com/manfredsteyer/angular-oauth2-oidc