{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7c38ec36-69dc-c2f7-834f-6e3ab4c9ba9f","name":"Ztar Mobile APIs","description":"The Ztar Mobile REST APIs exposes various core back-office functionality to customers, partners and vendors in order to  \nallow them to quickly integrate their systems with Ztar Mobile’s back-office platform.\n\nBased on REST principals, the APIs use the JSON open standard as the data serialization format for the response objects.  \nUsing REST in conjunction with JSON allows for rapid integration and debugging as the calls can be made from any  \nHTTP client in any language and the results are human readable.\n\nWhile this document lists all of the resources available, not all will be applicable to every implementation and access  \nto the various resources will be limited by the authentication token provided by the originating application. Your  \non-boarding contact will be able to assist you in determining which resources are applicable to your implementation.\n\n<h3>Message protocol</h3>\n\nThe Ztar Mobile message protocol standard is HTTPs v1.1. This standard facilitates all stated interactions with Ztar  \nMobile\n\n<h3>Ztar Mobile Development End Point</h3>\n\n<table><tbody><tr><td><div>End Point</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>https://services-test.ztarmobile.com</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Base URL</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>https://services-test.ztarmobile.com/ztarmobile/webservices/rest/vendor/{vendor}/</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>Ztar Mobile HA Production End Point</h3>\n\n<table><tbody><tr><td><div>End Point</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>https://services.ztarmobile.com</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Base URL</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>https://services.ztarmobile.com/ztarmobile/webservices/rest/vendor/{vendor}/</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>Message Security</h3>\n\n<ul><li><div>All communication will be over a secured HTTPs connection</div></li><li><div>HTTPS protocols utilized</div></li><li><ul><li><div>TLS 1.1 - accepted cipher suites listed bellow</div></li><li><ul><li><div>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</div></li></ul></li><li><div>TLS 1.2 - accepted cipher suites listed bellow</div></li><li><ul><li><div>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</div></li><li><div>TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</div></li><li><div>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384</div></li><li><div>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</div></li><li><div>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</div></li></ul></li></ul></li><li><div>Access to Ztar Mobile systems will be granted only to white-listed IPs from Vendor.</div></li><li><div>Vendor will be granted access to only those services outlined by their on-boarding contact.</div></li><li><div>Access to other Ztar Mobile services is explicitly prohibited.</div></li><li><div>Vendor will be responsible for maintaining privacy of all credentials provided by Ztar Mobile.</div></li><li><div>Rate limiting will be applied to all requests sent to the Base URL.</div></li><li><div>Vendor is limited to 2 identical requests per second per IP</div></li><li><div>Vendor is limited to 50 unique requests per second per IP</div></li><li><div>Violation of the above rate limit will result in a 5 minute IP Blacklisting. Any requests during the timeout window will result in an HTTP 403 (Forbidden) response and will reset the blacklist timeout window.</div></li></ul>\n\n<h3>HTTP Request headers</h3>\n\nRequired: Each HTTPS request must contain the following HTTP header fields:\n\n<table><tbody><tr><td><div><b>Header Name</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><b>Value</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><b>Format</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><b>API Version</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>vendor</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Partner’s unique vendor identifier string provided by Ztar Mobile.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Alphanumeric, at least 5 chars long – at most 20 chars long</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>2.0</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>market</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Partner’s market for operation provided by Ztar Mobile for the vendor.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Alphabetical, 2 chars only</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>2.0</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>product</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>A unique product identifier name provided by Ztar Mobile for the vendor.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Alphanumeric, at least 5 chars long – at most 20 chars long</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>2.0</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>authorization</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The authentication key that will be provided during the on-boarding process. This key will identify the calling<br>application.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Alphanumeric</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>1.0+</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>transactionId</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>A unique transaction ID. Will be used to debug and reconcile.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Alphanumeric, at least 10 chars long – at most 20 chars long</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>1.0+</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>Response MIME Type</h3>\n\nThe response MIME type will be _**application/json**_\n\n<h3>Response HTTP status</h3>\n\nThe Ztar Mobile REST APIs use standard HTTP status codes in order to represent the state of the request.\n\n<table><tbody><tr><td><div><b>Status</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><b>Description</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>200 OK</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request was successful. Response payload will be in the body of the HTTP response.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>204 No Content</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request was successful. No content is returned in the response.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400 Bad Request</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request was malformed – either some parameters were missing or were incorrectly formatted. The body of<br>the HTTP response may contain an optional<a rel=\"noreferrer noopener nofollow\" href=\"#_StatusResponse_Object\" target=\"_self\" url=\"#_StatusResponse_Object\">StatusResponse</a>object<br>that sheds more light on the error</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>401 Unauthorized</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The requested resource is not accessible to the authorization key provided</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403 Forbidden</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The IP from which the request originated from is not whitelisted for that resource.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404 Not Found</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The requested resource was not found.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>405 Method Not Allowed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The requested method is not supported by the resource</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>409 Conflict</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request failed due to a conflict with one of the parameters. The HTTP response will contain a<a rel=\"noreferrer noopener nofollow\" href=\"#_StatusResponse_Object\" target=\"_self\" url=\"#_StatusResponse_Object\">StatusResponse</a>object that sheds more light on the issue.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>500 Internal Server Error</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An Unexpected Error occurred. The body of the HTTP response may contain an optional<a rel=\"noreferrer noopener nofollow\" href=\"#_StatusResponse_Object\" target=\"_self\" url=\"#_StatusResponse_Object\">StatusResponse</a>object that sheds more light on the error</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>StatusResponse Object</h3>\n\nOn certain non-successful responses (HTTP status is not 200 or 204), the body of the HTTP response may include a StatusResponse  \nobject that further explains why the request failed.  \nPlease see the\n\n<a href=\"http://devdocs.ztarmobile.com/documentation/status-codes/\">status code list</a>\n\nfor available status codes and definitions.\n\n<h3>Standard Date Format</h3>\n\nAll JSON date strings will be returned in an ISO 8601 standard – **yyyy-MM-dd HH:mm:ss**  \ne.g. 2014-02-12 14:49:50\n\n<h3>Glossary</h3>\n\n<table><tbody><tr><td><div><b>Term</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><b>Definition</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ESN</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Equipment Serial Number. A decimal or hex string used to identify a specific CDMA handset. ESN was replaced<br>with MEID in newer handsets.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ICCID</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Integrated Circuit Card Identifier. A unique number that identifies each SIM card internationally. A full<br>ICCID is 19 or 20 digits.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>IMEI</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>International Mobile Station Equipment Identity is a number used to identify GSM handsets</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>MDN</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Mobile Device Number. The actual phone call of the wireless device.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>MEID</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Mobile Equipment Identifier. Supersedes the ESN on newer handsets.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>MSID</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Mobile Station ID. Also called MIN (Mobile Identification Number) a number that identifies the handset on<br>the CDMA network.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>MSL</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Master Subsidy Lock. A code used to unlock or set protected features on a CDMA handset.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>NPA</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Numbering Plan Area. The first 3 digits of phone number. Also known as area code.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>PRN</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Port Request Number. A unique identifier for a port request.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>SIM</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Subscriber Identity Module. A plastic card with an integrated circuit embedded on it used in GSM and LTE<br>handsets.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1338979","team":34407,"collectionId":"7c38ec36-69dc-c2f7-834f-6e3ab4c9ba9f","publishedId":"6Z2QY9Y","public":true,"publicUrl":"https://api.ztarmobile.com","privateUrl":"https://go.postman.co/documentation/1338979-7c38ec36-69dc-c2f7-834f-6e3ab4c9ba9f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2017-06-21T21:58:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e753d4be72cf68a798633cef358951c9ce9aeeec442c9713ee69def880c82b0d","favicon":"https://ztarmobile.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.ztarmobile.com/view/metadata/6Z2QY9Y"}