Quickstart — SIMSY Developers

From token to first request in five minutes

The fastest path from "I have a SIMSY account" to "I'm querying the network." Every call uses the same Bearer header against https://api.s-imsy.com/api/v1.

01

Get a developer account and SIM

Tell us what you're building and we'll set you up with a SIMSY portal account, a developer SIM or eSIM with starter credit, and access to the API. eSIM activation is a QR code, typically under a minute.

Request a developer account
02

Generate an API token

In the SIMSY portal, open API Tokens and create a new token. Copy it once — you won't see it again. Export it as an environment variable on the machine you're testing from.

terminal — your machine
$ export SIMSY_TOKEN="eyJhbGciOiJI..."   # your JWT from the portal

# Confirm the token is valid
$ curl https://api.s-imsy.com/api/v1/apitokens/verify \
  -H "Authorization: Bearer $SIMSY_TOKEN"
03

List your endpoints

An endpoint is a SIM and the device behind it. The list call returns every endpoint on your account, with identifiers (ICCID, IMSI, MSISDN), grouping, VSlice membership, routing policy, latest country and operator, current IP address, and rolling usage.

terminal
$ curl https://api.s-imsy.com/api/v1/endpoints \
  -H "Authorization: Bearer $SIMSY_TOKEN"

# Note an endpoint reference, ICCID, or id to use below.
04

Read status, location, and key-values

Most endpoint operations accept an id, ICCID, or your own reference as the path parameter. The status call returns the last-seen timestamp and network status. Location returns the latest country, operator, and access technology. Key-values store device configuration on the network itself, no on-device persistence needed.

terminal — replace {id} with your endpoint identifier
# Status: when was it last seen, what's its network state?
$ curl https://api.s-imsy.com/api/v1/endpoints/{id}/status \
  -H "Authorization: Bearer $SIMSY_TOKEN"

# Location: country, operator, RAT, latest update
$ curl https://api.s-imsy.com/api/v1/endpoints/{id}/location \
  -H "Authorization: Bearer $SIMSY_TOKEN"

# Key-values: device configuration held on the network
$ curl https://api.s-imsy.com/api/v1/endpoints/{id}/keyvalues \
  -H "Authorization: Bearer $SIMSY_TOKEN"
05

Subscribe to events

The Events resource lets you read past events on the account or a specific endpoint, and wire up event handlers and subscriptions to push events to your services as they happen.

terminal
# All recent events on the account
$ curl https://api.s-imsy.com/api/v1/events \
  -H "Authorization: Bearer $SIMSY_TOKEN"

# Events for a single endpoint
$ curl https://api.s-imsy.com/api/v1/endpoints/{id}/events \
  -H "Authorization: Bearer $SIMSY_TOKEN"

Try every endpoint in the browser

The full OpenAPI 3.0.1 reference is browsable and callable from simsy-ltd.github.io/api-docs. Paste your token, pick an endpoint, hit "Try it out".

Open the interactive docs

Pick a tool and build something real