Introduction
This document describes the Application Programming Interface (API) between Texting and Smart Services (TSS) and its users, such as Service Registrars and Responsible Organization (Resp Org) (collectively referred to as TSS User Clients). In general, TSS provides this API to allow users to take actions, via a protocol, that otherwise would only be available via the TSS web-based interface. The TSS User API version 2.0 contains performance enhancements to support more throughput and improved response times. The TSS User API version 1.0 will be supported for a period of time, but version 2.0 is the recommended way of interacting with TSS.
The following diagram shows the relevant network elements for the TSS User API. The arrows
highlighted in blue are the subjects of this document.
The User Client sends a REST request to https://api-texting.somos.com to be processed by the TSS
Business Logic. The POST encapsulates JSON, accesses the TSS Database as necessary, and returns a
response.
The following chapters separate the API discussion into:
Service Registrar API,
Resp Org API,
and Common API - relevant to both the Service Registrar and the Resp Org
Service Registrar API
The TSS REST API provides an easy-to-use set of HTTP endpoints that let you access data in simple JSON format. The Service Registrar makes a HTTP POST request containing JSON payload to the TSS Server. The TSS Server responds to the POSTs with JSON, after processing the request. Standard HTTP status codes are replied to the users of TSS API services using JSON over HTTP.
The HTTP requests are identified by its endpoints (URL). The following table enumerates the possible HTTP endpoints.