{"_id":"5951a9e8ee9bc9001bb95915","project":"55f0757d4624ec2d00814345","version":{"_id":"593878f2682adc0031784bf3","project":"55f0757d4624ec2d00814345","__v":1,"createdAt":"2017-06-07T22:06:42.610Z","releaseDate":"2017-06-07T22:06:42.610Z","categories":["593878f2682adc0031784bf4","593878f2682adc0031784bf5","593878f2682adc0031784bf6","593878f2682adc0031784bf7","593878f2682adc0031784bf8","593878f2682adc0031784bf9","593878f2682adc0031784bfa","593878f2682adc0031784bfb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"593878f2682adc0031784bf4","version":"593878f2682adc0031784bf3","project":"55f0757d4624ec2d00814345","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T18:07:58.231Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"user":"55f0756a1e63fc37004b8d2b","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-27T00:42:16.883Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The TigerText platform enables customers and partners to build services that interact with our industry-leading, HIPAA-compliant secure messaging solution.  The following documentation describes the TigerText platform, and includes tutorials that will help you get started with our API.\n\nWhen you are done, you will know the key objects in the TigerText platform, how they work and how to interact with them and most importantly, how you can leverage them for your use case.  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\n## Create a TigerText Account\n\nBefore you begin, you will need to create a TigerText account.  If you do not already have a TigerText account, you may download our mobile app for iOS or Android, and then sign up for a free account.  \n\n## Obtain a Key and Secret\n\nOnce you have created an account with TigerText, you will need a key and secret to begin coding using our API.  Please contact your Sales or Account rep, who can provide you with the necessary API credentials.\n\nThis information can be used as authentication for interacting with our [REST API](doc:rest-api).  For each endpoint, feel free to \"Try It Out\" using our API Explorer.  Add your Key and Secret to the associated User Info dialogue as shown below.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/yzQZpy1gTravBCSiPSFE_User_Info_API.png\",\n        \"User_Info_API.png\",\n        \"557\",\n        \"206\",\n        \"#2b2b2b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Code away!\nYou are now ready to explore the TigerText API, and a good place to begin is with an [API Overview](doc:rest-api).   For those that want to jump right in, feel free to check out detailed documentation for specific endpoints in our [REST API](doc:api-endpoints), or [send your first message](doc:message) using the tools in this Developer Portal.  \n\nFinally, we are here to help.  If you have any questions, you can always [contact us](mailto:developersupport:::at:::tigertext.com?Subject=TigerText%20Question).","excerpt":"","slug":"tigertext-platform-overview","type":"basic","title":"TigerText Platform Overview"}

TigerText Platform Overview


The TigerText platform enables customers and partners to build services that interact with our industry-leading, HIPAA-compliant secure messaging solution. The following documentation describes the TigerText platform, and includes tutorials that will help you get started with our API. When you are done, you will know the key objects in the TigerText platform, how they work and how to interact with them and most importantly, how you can leverage them for your use case. [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] ## Create a TigerText Account Before you begin, you will need to create a TigerText account. If you do not already have a TigerText account, you may download our mobile app for iOS or Android, and then sign up for a free account. ## Obtain a Key and Secret Once you have created an account with TigerText, you will need a key and secret to begin coding using our API. Please contact your Sales or Account rep, who can provide you with the necessary API credentials. This information can be used as authentication for interacting with our [REST API](doc:rest-api). For each endpoint, feel free to "Try It Out" using our API Explorer. Add your Key and Secret to the associated User Info dialogue as shown below. [block:image] { "images": [ { "image": [ "https://files.readme.io/yzQZpy1gTravBCSiPSFE_User_Info_API.png", "User_Info_API.png", "557", "206", "#2b2b2b", "" ] } ] } [/block] ## Code away! You are now ready to explore the TigerText API, and a good place to begin is with an [API Overview](doc:rest-api). For those that want to jump right in, feel free to check out detailed documentation for specific endpoints in our [REST API](doc:api-endpoints), or [send your first message](doc:message) using the tools in this Developer Portal. Finally, we are here to help. If you have any questions, you can always [contact us](mailto:developersupport@tigertext.com?Subject=TigerText%20Question).