Smartphone Test Farm API

by openstf.io

Overview

Control and manages real Smartphone devices from browser and restful apis

Smartphone Test Farm is a phone API from openstf.io. Requests are authenticated with an API key. It is served over plain HTTP. Its OpenAPI description documents 10 endpoints.

At a glance

Authentication: API key
HTTPS: No
CORS: Unknown
Category: Phone
Base URL: http://openstf.local/api/v1
Version: 2.3.0
Endpoints: 10
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "http://openstf.local/api/v1/devices" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("http://openstf.local/api/v1/devices", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://openstf.local/api/v1/devices",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/devices`	Device List
GET	`/devices/{serial}`	Device Information
GET	`/user`	User Profile
GET	`/user/accessTokens`	Access Tokens
GET	`/user/devices`	User Devices
POST	`/user/devices`	Add a device to a user
GET	`/user/devices/{serial}`	User Device
DELETE	`/user/devices/{serial}`	Delete User Device
POST	`/user/devices/{serial}/remoteConnect`	Remote Connect
DELETE	`/user/devices/{serial}/remoteConnect`	Remote Disconnect

Questions

Does the Smartphone Test Farm API need an API key?

Yes. The Smartphone Test Farm API uses API key authentication; the documentation explains how to get credentials.

Does the Smartphone Test Farm API support HTTPS?

The Smartphone Test Farm API is listed as HTTP only, so avoid sending secrets to it.

How many endpoints does the Smartphone Test Farm API have?

Its OpenAPI description lists 10 endpoints in version 2.3.0. All of them are shown on this page.

What are alternatives to the Smartphone Test Farm API?

Other Phone APIs include Twilio - Accounts, ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, Twilio - Api, Mobility API, Telnyx API.

Compare alternatives →

Twilio - Accounts

Phone

This is the public Twilio REST API.

HTTP Basic13 endpoints

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management

Phone

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.

No auth16 endpoints

Twilio - Api

Phone

This is the public Twilio REST API.

HTTP Basic199 endpoints

Mobility API

Phone

Transit API can be used to obtain time-aggregated data representing moving the people between various spatial points within the Czech Republic. Having A - 'from' and B - 'to' points, the API can return count of people traveling from A to B or people that are from A and traveling to B, etc. The mobility data is based on moving mobile stations in O2 mobile network.

No auth2 endpoints