Skip to main content

v1: API documentation published

This site is now the single source of truth for the Tornet SDP SP-facing API. Everything here describes v1, which is the current and only version.

What is documented​

  • Subscription (Landing Page): PIN opt-in, verification, status and unsubscribe
  • One-Time Purchase: a single charge with a one-time code
  • Header Enrichment: one-tap opt-in on the operator's mobile data
  • Send SMS: one message to a subscriber of your service
  • DataSync: the event feed, its signature scheme and its delivery guarantees
  • Reference: the response envelope, the full error-code catalogue, idempotency, rate limits, and a call-by-call migration guide from the legacy platform

How versioning works here​

The API version is in the path: /api/sp/v1/. It changes only for a breaking change.

  • v1 keeps working when v2 exists. You move when you choose to, not when we ship.
  • Additive changes happen within a version: a new optional field, a new error code, a new endpoint. Those are announced here rather than by a version bump.
  • When a new version is published, this site keeps the older version's documentation available and a version selector appears. Nothing is deleted.

So a breaking change will never arrive quietly under a version you are already using. That is the guarantee the path-based version exists to give.

What gets an entry here​

Every change that could affect an integration:

  • a new endpoint, field or error code
  • a change to behaviour, limits or defaults
  • a correction to this documentation where the previous text could have misled you

Corrections are announced, not silently edited. If we got something wrong here, the entry says so, because you may have built against the wrong version of it.

Subscribe to the feed at /changelog/rss.xml to hear about changes without checking.

Known gaps, stated deliberately​

Three things do not exist yet, and the Testing section says so in detail rather than leaving you to discover them:

  • No self-service sandbox. Integration testing is coordinated with the operator team.
  • No deterministic test numbers that always succeed or always fail.
  • No DataSync echo endpoint for verifying a receiver on your own.

These are on the roadmap, not oversights. They will get changelog entries when they land.