Truphone (1GLOBAL) Devices API

Connected device management and automation rules.

OpenAPI Specification

truphone-devices-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Truphone (1GLOBAL) IoT Portal Connectivity Devices API
  description: 'REST API for the Truphone (now 1GLOBAL) IoT Portal, providing SIM / eSIM lifecycle management, connectivity and data-usage inspection, rate plans and subscriptions, and IoT device management. The API is JSON-based: request and response bodies use Content-Type application/json, each operation has a URI (for example /api/v2.2/sims) and may reference a specific resource by ICCID or ID. Truphone was acquired and rebranded to 1GLOBAL in 2022; the IoT Portal API host remains iot.truphone.com while product documentation now lives on 1global.com. eSIM ordering and activation for 1GLOBAL Connect use a separate host (services.truphone.com/connect-api); see the description on the Order operations below. Endpoints, paths, and the token authentication scheme below are documented; request/response schemas are summarized and not exhaustive.'
  termsOfService: https://www.1global.com
  contact:
    name: 1GLOBAL (Truphone) Support
    url: https://docs.things.1global.com/apireference/
  version: '2.2'
servers:
- url: https://iot.truphone.com/api
  description: 1GLOBAL IoT Portal API (legacy Truphone host)
security:
- TokenAuth: []
tags:
- name: Devices
  description: Connected device management and automation rules.
paths:
  /v2.2/devices:
    get:
      operationId: listDevices
      tags:
      - Devices
      summary: List devices
      description: List connected devices.
      responses:
        '200':
          description: A list of devices.
  /v2.2/devices/{id}:
    get:
      operationId: getDevice
      tags:
      - Devices
      summary: Get a device
      description: Retrieve a device's configuration.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Device detail.
    patch:
      operationId: updateDevice
      tags:
      - Devices
      summary: Update a device
      description: Update a device's settings.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated device.
components:
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Supply the header `Authorization: Token <api-key>`. (1GLOBAL Connect and the 1GLOBAL platform API on services.truphone.com use OAuth2 / bearer tokens instead; see provider documentation.)'