{"__v":11,"_id":"566bf164737e260d00c698de","category":{"__v":4,"_id":"55312175c68f493900aebb43","pages":["55312175c68f493900aebb45","566bf164737e260d00c698de","566bf46e737e260d00c698e1","566bf708cb3d040d00abae1f"],"project":"55312174c68f493900aebb3f","version":"55312174c68f493900aebb42","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-17T15:06:29.145Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"project":"55312174c68f493900aebb3f","user":"5531215e29603d2300011341","version":{"__v":10,"_id":"55312174c68f493900aebb42","project":"55312174c68f493900aebb3f","createdAt":"2015-04-17T15:06:28.598Z","releaseDate":"2015-04-17T15:06:28.598Z","categories":["55312175c68f493900aebb43","566b431d03b4b20d00d02c3a","566b58f212bc0517005d3068","566b59110506f40d0034f148","566b7cc94d1a4d0d00801c00","566b82d130cdb417008d217d","566b855b4d1a4d0d00801c04","566b856f03870a0d008ee7a7","566c42d2f0a5dc0d009acbab","566c443d85dc790d0062c134"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.7.0","version":"0.7"},"updates":["58f20e8e5a39df1900f4bad9"],"next":{"pages":[],"description":""},"createdAt":"2015-12-12T10:05:24.830Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":2,"body":"App IDs are 32 hexadecimal (0-9/A-F) characters long, and are unique to each account. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you have an App ID already, you can enter it into the API Explorer in the API endpoint documentation pages to have it pre-filled and sent with your test requests. \\n\\nUse the 'Key' icon and enter it next to `app_id`.\",\n  \"title\": \"API Explorer\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Register for an App ID\"\n}\n[/block]\nYou can **[sign up here](http://openexchangerates.org/signup/)** for your App ID.\n\nIf you've already signed up, you can visit your [account dashboard](http://openexchangerates.org/account) at any time to view your App ID.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using Your App ID\"\n}\n[/block]\nTo access any of the API routes, simply append your App ID as a parameter on the end of each request, like so:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://openexchangerates.org/api/latest.json?app_id=[[app:app_id]]\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nMost code samples, extensions, plugins and libraries built for our API have a setting or variable where you can enter your App ID.\n\nApp IDs should be kept as secret as possible, but if you're developing in client-side JavaScript, your App ID will be visible in your public source code. We haven't found this to be an issue, but we're working on more advanced authentication for the next version of the API. If you suspect somebody is using your App ID without your permission, [we can regenerate it for you](http://docs.openexchangerates.org/v0.7/docs/authentication#regenerating-your-app-id).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tracking App ID Usage\"\n}\n[/block]\nTo track the usage of your App ID, you can log in to your account dashboard and visit the Usage Statistics page.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"If your account usage goes over the monthly threshold for your plan, we'll email you to discuss options that would best suit your current usage.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Regenerating Your App ID\"\n}\n[/block]\nIf you need to request a new App ID for any reason, <a href=\"mailto:support:::at:::openexchangerates.org&subject=New+App+Id\" target=\"_blank\">contact us</a> and we'll email you with a new one.","excerpt":"The Open Exchange Rates API currently supports basic App ID authentication via the `app_id` parameter.","slug":"authentication","type":"basic","title":"Authentication"}

Authentication

The Open Exchange Rates API currently supports basic App ID authentication via the `app_id` parameter.

App IDs are 32 hexadecimal (0-9/A-F) characters long, and are unique to each account. [block:callout] { "type": "info", "body": "If you have an App ID already, you can enter it into the API Explorer in the API endpoint documentation pages to have it pre-filled and sent with your test requests. \n\nUse the 'Key' icon and enter it next to `app_id`.", "title": "API Explorer" } [/block] [block:api-header] { "type": "basic", "title": "Register for an App ID" } [/block] You can **[sign up here](http://openexchangerates.org/signup/)** for your App ID. If you've already signed up, you can visit your [account dashboard](http://openexchangerates.org/account) at any time to view your App ID. [block:api-header] { "type": "basic", "title": "Using Your App ID" } [/block] To access any of the API routes, simply append your App ID as a parameter on the end of each request, like so: [block:code] { "codes": [ { "code": "https://openexchangerates.org/api/latest.json?app_id=[[app:app_id]]", "language": "http" } ] } [/block] Most code samples, extensions, plugins and libraries built for our API have a setting or variable where you can enter your App ID. App IDs should be kept as secret as possible, but if you're developing in client-side JavaScript, your App ID will be visible in your public source code. We haven't found this to be an issue, but we're working on more advanced authentication for the next version of the API. If you suspect somebody is using your App ID without your permission, [we can regenerate it for you](http://docs.openexchangerates.org/v0.7/docs/authentication#regenerating-your-app-id). [block:api-header] { "type": "basic", "title": "Tracking App ID Usage" } [/block] To track the usage of your App ID, you can log in to your account dashboard and visit the Usage Statistics page. [block:callout] { "type": "success", "body": "If your account usage goes over the monthly threshold for your plan, we'll email you to discuss options that would best suit your current usage." } [/block] [block:api-header] { "type": "basic", "title": "Regenerating Your App ID" } [/block] If you need to request a new App ID for any reason, <a href="mailto:support@openexchangerates.org&subject=New+App+Id" target="_blank">contact us</a> and we'll email you with a new one.