{"__v":23,"_id":"55f0b2b7f3735d0d00692006","category":{"__v":29,"_id":"55f0b2b5f3735d0d00692001","pages":["55f0b2b6f3735d0d00692003","55f0b536f3735d0d0069200b","55f0c6eaf3735d0d00692097","55fa0c0f8065a10d004e5b77","55fa0db60e1f1f1700a1f6ec","55fa0e9ea663c00d00773d9c","55fa0f0eaba81f0d00a115a4","55fa0f9e17b9d00d00969e55","55fa1008aba81f0d00a115a5","55fa13e117b9d00d00969e68","55fa14460e1f1f1700a1f6f4","55fa14f517b9d00d00969e70","55fa166b8065a10d004e5b8b","55fa16a8aba81f0d00a115b0","55fa175aaba81f0d00a115be","55fa17868065a10d004e5b94","55faf3f6626c341700fd9e93","55faf49d825d5f19001fa381","55faf4c317b9d00d00969f44","560096b297f69f1700f21a44","56009d7081a9670d006d1470","56009e653aa0520d00da0c0b","563ceed6260dde0d00c5ea2e","563cf07d9799fb0d00047725","563d008eae97cc0d00a9009f","563d3fa38894d20d00014f64","5669f229a4968c2d001d8084","56cbb3d76b06f11d0040f154","56cf4d11336aa60b0086a235"],"project":"55f0757d4624ec2d00814345","version":"55f0b2b5f3735d0d00691ffe","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T22:10:31.668Z","from_sync":false,"order":6,"slug":"rest-api","title":"REST API"},"parentDoc":null,"project":"55f0757d4624ec2d00814345","user":"55f0756a1e63fc37004b8d2b","version":{"__v":9,"_id":"55f0b2b5f3735d0d00691ffe","project":"55f0757d4624ec2d00814345","createdAt":"2015-09-09T22:29:09.118Z","releaseDate":"2015-09-09T22:29:09.118Z","categories":["55f0b2b5f3735d0d00691fff","55f0b2b5f3735d0d00692000","55f0b2b5f3735d0d00692001","55f0bd67d5d8fc0d00ca6f44","55f0cde9d5d8fc0d00ca6f55","563a8a62a8ba320d00106830","563a8ac9a8ba320d00106832","563d410f31f7580d00511e53","563d411de79f670d00a10a5f","563d412a31f7580d00511e54","566a206f74d574170070b640"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-09T21:51:49.928Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The TigerConnect API is a RESTful interface, providing programmatic access to much of the data in the system. It provides URLs for accessing TigerConnect objects, and uses built-in HTTP features to receive commands and return responses.\n\nFor faster and easier integration into web and mobile applications, be sure to also check out our software development kits.\n- [JS SDK](doc:javascript-quick-start) \n- [IOS SDK](doc:ios-quick-start) \n- [Android SDK](doc:android-quick-start) \n- [.NET SDK](doc:dotnet-quick-start)  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Postman\"\n}\n[/block]\n[![Run TigerConnect in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/255c58cd04f36edc3eba)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nTigerConnect API Endpoints require user authentication. It's implemented using Basic HTTP Authentication using an API Key as the username and the corresponding API Secret as the password which is located at the top of the page.\n\nWith your API Key and Secret, you will be able to send up to 100 messages per day. You are probably wondering: why the limit? We just want to make sure that you aren’t abusing our platform. If you get the error message \"Too many requests/second, please try again later,\" don’t be alarmed. If 100 messages a day is not enough for what you are trying to build, please [Contact Us](mailto:developer:::at:::tigertext.com?Subject=TigerConnect%20Question).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request and Response Formats\"\n}\n[/block]\nTigerText API Endpoints support different content types. To determine how to parse the body of a post, TigerConnect checks the Content-Type header. Here are three types that are accepted with a quick example.\n\n##JSON\n\nA JSON object is expected in this case. All response formats will return in this format.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -u [API Key]:[API Secret] \\\\\\n-vX POST https://developer.tigertext.me/v2/message \\\\\\n-H \\\"Content-Type: application/json\\\" \\\\\\n-d '{\\\"recipient\\\":\\\"echobot@tigertext.com\\\", \\\"body\\\":\\\"Hello World\\\"}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n##Form Encoded Data\n\nForm Encoded Data is another option that is accepted. We used this format when sending your first TigerConnect message.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -u [API Key]:[API Secret] \\\\\\n-vX POST https://developer.tigertext.me/v2/message \\\\\\n-H \\\"Content-Type: application/x-www-form-urlencoded\\\" \\\\ \\n-d \\\"recipient=echobot@tigertext.com\\\" \\\\ \\n-d \\\"body=Hello World\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n##Multipart Form\n\nAPI endpoints that allow the upload of files.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -u [API Key]:[API Secret] \\\\\\n-vX POST https://developer.tigertext.me/v2/message \\\\\\n--data-binary @test \\\\ \\n-H \\\"Content-Type: multipart/form-data;Boundary=xBoundaryx\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nWhere these are the contents of test:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"--xBoundaryx \\nContent-Disposition: form-data; name=\\\"body\\\" \\nBody \\n--xBoundaryx \\nContent-Disposition: form-data; name=\\\"recipient\\\" \\nechobot@tigertext.com \\n\\n--xBoundaryx \\nContent-Disposition: format-data; name=\\\"attachment\\\" \\nContent-Type: image/png \\n[some bytes]\\n\\n--xBoundaryx--\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP Response Codes\"\n}\n[/block]\n##Success Response Codes\n[block:parameters]\n{\n  \"data\": {\n    \"1-0\": \"204 No Content\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"Everything is ok\",\n    \"1-1\": \"An update was made successfully\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Error Response Codes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"400 Bad Request\",\n    \"1-0\": \"403 Forbidden\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"The associated lookup was not found\",\n    \"1-1\": \"The API key does not have access\",\n    \"0-1\": \"The provided parameters are somehow incorrect. A description of the error will be provided.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"rest-api","type":"basic","title":"Overview"}
The TigerConnect API is a RESTful interface, providing programmatic access to much of the data in the system. It provides URLs for accessing TigerConnect objects, and uses built-in HTTP features to receive commands and return responses. For faster and easier integration into web and mobile applications, be sure to also check out our software development kits. - [JS SDK](doc:javascript-quick-start) - [IOS SDK](doc:ios-quick-start) - [Android SDK](doc:android-quick-start) - [.NET SDK](doc:dotnet-quick-start) [block:api-header] { "type": "basic", "title": "Postman" } [/block] [![Run TigerConnect in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/255c58cd04f36edc3eba) [block:api-header] { "type": "basic", "title": "Authentication" } [/block] TigerConnect API Endpoints require user authentication. It's implemented using Basic HTTP Authentication using an API Key as the username and the corresponding API Secret as the password which is located at the top of the page. With your API Key and Secret, you will be able to send up to 100 messages per day. You are probably wondering: why the limit? We just want to make sure that you aren’t abusing our platform. If you get the error message "Too many requests/second, please try again later," don’t be alarmed. If 100 messages a day is not enough for what you are trying to build, please [Contact Us](mailto:developer@tigertext.com?Subject=TigerConnect%20Question). [block:api-header] { "type": "basic", "title": "Request and Response Formats" } [/block] TigerText API Endpoints support different content types. To determine how to parse the body of a post, TigerConnect checks the Content-Type header. Here are three types that are accepted with a quick example. ##JSON A JSON object is expected in this case. All response formats will return in this format. [block:code] { "codes": [ { "code": "curl -u [API Key]:[API Secret] \\\n-vX POST https://developer.tigertext.me/v2/message \\\n-H \"Content-Type: application/json\" \\\n-d '{\"recipient\":\"echobot@tigertext.com\", \"body\":\"Hello World\"}'", "language": "curl" } ] } [/block] ##Form Encoded Data Form Encoded Data is another option that is accepted. We used this format when sending your first TigerConnect message. [block:code] { "codes": [ { "code": "curl -u [API Key]:[API Secret] \\\n-vX POST https://developer.tigertext.me/v2/message \\\n-H \"Content-Type: application/x-www-form-urlencoded\" \\ \n-d \"recipient=echobot@tigertext.com\" \\ \n-d \"body=Hello World\"", "language": "curl" } ] } [/block] ##Multipart Form API endpoints that allow the upload of files. [block:code] { "codes": [ { "code": "curl -u [API Key]:[API Secret] \\\n-vX POST https://developer.tigertext.me/v2/message \\\n--data-binary @test \\ \n-H \"Content-Type: multipart/form-data;Boundary=xBoundaryx\"", "language": "curl" } ] } [/block] Where these are the contents of test: [block:code] { "codes": [ { "code": "--xBoundaryx \nContent-Disposition: form-data; name=\"body\" \nBody \n--xBoundaryx \nContent-Disposition: form-data; name=\"recipient\" \nechobot@tigertext.com \n\n--xBoundaryx \nContent-Disposition: format-data; name=\"attachment\" \nContent-Type: image/png \n[some bytes]\n\n--xBoundaryx--", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "HTTP Response Codes" } [/block] ##Success Response Codes [block:parameters] { "data": { "1-0": "204 No Content", "0-0": "200 OK", "0-1": "Everything is ok", "1-1": "An update was made successfully" }, "cols": 2, "rows": 2 } [/block] ##Error Response Codes [block:parameters] { "data": { "0-0": "400 Bad Request", "1-0": "403 Forbidden", "2-0": "404 Not Found", "2-1": "The associated lookup was not found", "1-1": "The API key does not have access", "0-1": "The provided parameters are somehow incorrect. A description of the error will be provided." }, "cols": 2, "rows": 3 } [/block]