{"_id":"560d5ac91ec45619006069dc","githubsync":"","order":0,"slug":"getting-started","updates":["57964360f64c9f0e007cd71a"],"title":"iExit API Overview","__v":14,"api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[]}},"link_external":false,"link_url":"","project":"560d5ac71ec45619006069d6","category":"560d5ac81ec45619006069da","createdAt":"2015-10-01T16:09:45.025Z","isReference":false,"version":"560d5ac71ec45619006069d9","body":"Our REST API allows programmatic access to the iExit database and platform so developers can build iExit-like functionality into their own software.\n\nEach API resource has available actions that can be performed on it. Supported resources and their endpoints are listed on the left.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Paid Access\"\n}\n[/block]\nAccess to the iExit API allowed only after purchasing an API key. Each API key is associated with an iExit API partner. \n\n** Obtaining an API Key **\n\nAPI keys are only available to 3rd parties who have paid to license the iExit database. If you are interested in creating an iExit integration inside of your software, please contact us for pricing information at **[api:::at:::iexitapp.com](mailto:api@iexitapp.com)**. After you contact us, we may issue a trial API key with limited number of requests so that you can play around and better learn the iExit API.\n\nWhen contacting **[api@iexitapp.com](mailto:api@iexitapp.com)**, please be sure to include what your software does and how you intend to use iExit inside of it.\n\n** API Key HTTP Header **\n\nEach request to our API requires a valid API key to be passed as an `HTTP header`. There is no need to issue any login commands or to maintain a session. The API key must be passed with the key `apikey`.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"API Key Security\",\n  \"body\": \"API keys are secret. We strongly recommend against pasting it online or committing it to a repository. Treat it as you would your password.\"\n}\n[/block]\n** Example Request **\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.iexitapp.com/v1/states -H 'apikey=\\\"YOUR_API_KEY\\\"'\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Schema\"\n}\n[/block]\n- API Base URL: https://api.iexitapp.com/v1/\n- All API access is over HTTPS\n- All data is received as JSON\n- All API endpoints respond only to the GET `http verb`. This is because the iExit API is entirely read-only (for now).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Codes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200\",\n    \"0-1\": \"OK\",\n    \"0-2\": \"Everything went great. Be sure to read that specific API's documentation to see what to expect with the response.\",\n    \"2-0\": \"422\",\n    \"2-1\": \"Unprocessable Entity\",\n    \"2-2\": \"You supplied an invalid API key and cannot access this API.\",\n    \"3-0\": \"500\",\n    \"3-1\": \"Internal Server Error\",\n    \"3-2\": \"Hopefully you never see this. If you do that means that we are either having some downtime or you found a bug. If the problem persists, please let us know at **[support@iexitapp.com](mailto:support@iexitapp.com)** and we'll get right on it!\",\n    \"1-0\": \"400\",\n    \"1-1\": \"Bad Request\",\n    \"1-2\": \"An `id` value(s) supplied in the URL was invalid.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"Welcome to the iExit API docs","hidden":false,"sync_unique":"","type":"basic","user":"560d5a4faf97231900938125","parentDoc":null,"childrenPages":[]}

iExit API Overview

Welcome to the iExit API docs

Our REST API allows programmatic access to the iExit database and platform so developers can build iExit-like functionality into their own software. Each API resource has available actions that can be performed on it. Supported resources and their endpoints are listed on the left. [block:api-header] { "type": "basic", "title": "Paid Access" } [/block] Access to the iExit API allowed only after purchasing an API key. Each API key is associated with an iExit API partner. ** Obtaining an API Key ** API keys are only available to 3rd parties who have paid to license the iExit database. If you are interested in creating an iExit integration inside of your software, please contact us for pricing information at **[api@iexitapp.com](mailto:api@iexitapp.com)**. After you contact us, we may issue a trial API key with limited number of requests so that you can play around and better learn the iExit API. When contacting **[api@iexitapp.com](mailto:api@iexitapp.com)**, please be sure to include what your software does and how you intend to use iExit inside of it. ** API Key HTTP Header ** Each request to our API requires a valid API key to be passed as an `HTTP header`. There is no need to issue any login commands or to maintain a session. The API key must be passed with the key `apikey`. [block:callout] { "type": "warning", "title": "API Key Security", "body": "API keys are secret. We strongly recommend against pasting it online or committing it to a repository. Treat it as you would your password." } [/block] ** Example Request ** [block:code] { "codes": [ { "code": "curl https://api.iexitapp.com/v1/states -H 'apikey=\"YOUR_API_KEY\"'", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "Schema" } [/block] - API Base URL: https://api.iexitapp.com/v1/ - All API access is over HTTPS - All data is received as JSON - All API endpoints respond only to the GET `http verb`. This is because the iExit API is entirely read-only (for now). [block:api-header] { "type": "basic", "title": "Response Codes" } [/block] [block:parameters] { "data": { "h-0": "Code", "h-1": "Name", "h-2": "Description", "0-0": "200", "0-1": "OK", "0-2": "Everything went great. Be sure to read that specific API's documentation to see what to expect with the response.", "2-0": "422", "2-1": "Unprocessable Entity", "2-2": "You supplied an invalid API key and cannot access this API.", "3-0": "500", "3-1": "Internal Server Error", "3-2": "Hopefully you never see this. If you do that means that we are either having some downtime or you found a bug. If the problem persists, please let us know at **[support@iexitapp.com](mailto:support@iexitapp.com)** and we'll get right on it!", "1-0": "400", "1-1": "Bad Request", "1-2": "An `id` value(s) supplied in the URL was invalid." }, "cols": 3, "rows": 4 } [/block]