developers.watsi.orgGetting Started · Watsi

Watsi {"id":"53a47666447c0ba24d1a85cb","name":"Watsi","subdomain":"watsi","versions":[{"_id":"53a47666447c0ba24d1a85ce","releaseDate":"2014-06-20T17:59:02.652Z","is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.1.0","version":"0.1"},{"_id":"569ebe312d320817003b80b8","releaseDate":"2016-01-19T22:52:33.817Z","is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"Humble Bundle API, never used in production","version_clean":"1.0.0","version":"1"}],"current_version":{"version_clean":"0.1.0","version":"0.1"},"oauth":{"enabled":false},"api":{"name":"","url":"https://watsi.org","contenttype":null,"auth":null,"explorer":null,"proxyEnabled":true,"jwt":null,"authextra":null,"headers":null,"object_definitions":[]},"apiAlt":[{"_id":"569ebb59ebbadc0d0079bf60","object_definitions":[],"headers":[],"authextra":[{"_id":"569ebd12d233620d007055f8","type":"header","default":"Token token=\"api_auth_token\", email=\"donor_email\"","key":"Authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://api.watsi.org/v:version","name":"v1"}],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"newApiExplorer":false,"cacheEnabled":true,"autoSslGeneration":true},"asset_base_url":""} Support v0.1 v{{v.version}} latest beta private deprecated View all versions Documentation Getting Started Using the Watsi API? Endpoints get /fund-treatments.json get /profile/:token.json get /donor/:token.json Getting Help Next Steps {"_id":"53a47666447c0ba24d1a85d1","body":"Watsi has a read-only API for retrieving information about patients and donors. We will attempt to follow [jsonapi](http://jsonapi.org/) standards.\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"Unstable API\",\n \"body\": \"While we are doing our best to keep these API endpoints stable, v1.0 has not been frozen. It is possible the APIs will change.\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"Currently, our API endpoints are not set up with CORS and cannot be accessed from browser-side JavaScript. You will have to proxy the request through a server.\",\n \"title\": \"Accessing via AJAX\"\n}\n[/block]","category":"53a47666447c0ba24d1a85cf","excerpt":"","hidden":false,"tags":[],"title":"Getting Started","type":"basic","isReference":false,"updates":[],"version":"53a47666447c0ba24d1a85ce","sync_unique":"","__v":8,"api":{"auth":"never","params":[],"results":{"codes":[]},"settings":"","try":true,"url":""},"comments":[],"githubsync":"","is_link":false,"order":0,"createdAt":"2014-06-20T17:59:02.732Z","link_external":false,"link_url":"","project":"53a47666447c0ba24d1a85cb","slug":"getting-started","user":"53a47639447c0ba24d1a85ca","metadata":{"title":"","description":"","image":[]},"childrenPages":[]} Getting Started Watsi has a read-only API for retrieving information about patients and donors. We will attempt to follow [jsonapi](http://jsonapi.org/) standards. [block:callout] { "type": "danger", "title": "Unstable API", "body": "While we are doing our best to keep these API endpoints stable, v1.0 has not been frozen. It is possible the APIs will change." } [/block] [block:callout] { "type": "warning", "body": "Currently, our API endpoints are not set up with CORS and cannot be accessed from browser-side JavaScript. You will have to proxy the request through a server.", "title": "Accessing via AJAX" } [/block] Edit this Page Suggest Edits get /fund-treatments.json get /profile/:token.json get /donor/:token.json View all 3 endpoints Watsi has a read-only API for retrieving information about patients and donors. We will attempt to follow [jsonapi](http://jsonapi.org/) standards. [block:callout] { "type": "danger", "title": "Unstable API", "body": "While we are doing our best to keep these API endpoints stable, v1.0 has not been frozen. It is possible the APIs will change." } [/block] [block:callout] { "type": "warning", "body": "Currently, our API endpoints are not set up with CORS and cannot be accessed from browser-side JavaScript. You will have to proxy the request through a server.", "title": "Accessing via AJAX" } [/block] {"_id":"5424f7ecae542a1a7d7c5f76","link_external":false,"link_url":"","title":"Using the Watsi API?","updates":[],"is_link":false,"project":"53a47666447c0ba24d1a85cb","api":{"auth":"never","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"settings":"","try":true,"url":""},"body":"If you're using the Watsi API for something cool, please let us know!","createdAt":"2014-09-26T05:21:48.955Z","excerpt":"","hidden":false,"isReference":false,"type":"basic","__v":3,"githubsync":"","order":1,"slug":"using-the-watsi-api","sync_unique":"","user":"5250b3ad5ac09b3564000005","category":"53a47666447c0ba24d1a85cf","version":"53a47666447c0ba24d1a85ce","metadata":{"title":"","description":"","image":[]},"childrenPages":[]} Using the Watsi API? If you're using the Watsi API for something cool, please let us know! Edit this Page Suggest Edits If you're using the Watsi API for something cool, please let us know! {"_id":"5424ef78ae542a1a7d7c5f6a","order":0,"project":"53a47666447c0ba24d1a85cb","title":"/fund-treatments.json","type":"get","excerpt":"","category":"5424ef12ae542a1a7d7c5f66","isReference":false,"sync_unique":"","user":"5250b3ad5ac09b3564000005","__v":20,"api":{"params":[],"url":"/fund-treatments.json","auth":"never","basic_auth":false,"method":"get","try":true,"examples":{"codes":[]},"results":{"codes":[{"name":"Success","code":"{\n \"profiles\": [\n {\n \"token\": \"dfed290e4ee7\",\n \"name\": \"Kioko\",\n \"header\": \"Kioko is a father of three from Kenya who needs $1,500 to treat his infected bone.\",\n \"age_years\": 38,\n \"age_months\": null,\n \"partner_name\": \"African Mission Healthcare Foundation\",\n \"country\": \"Kenya\",\n \"url\": \"https://watsi.org/profile/dfed290e4ee7-kioko\",\n \"photo_url\": \"https://d3w52z135jkm97.cloudfront.net/uploads/profile/photo/7897/profile_638x479_cee62d53-3273-4238-8d02-1a98e4787aa5.JPG\",\n \"percent_funded\": 0,\n \"target_amount\": 150000,\n \"amount_remaining\": 150000,\n \"amount_raised\": 0,\n \"number_of_donors\": 0\n },\n //...more profiles...\n ]\n}","language":"json"},{"language":"json","code":"{\n \"message\": \"Sorry, that resource cannot be found\"\n}"}]},"settings":""},"body":"Calling `/fund-treatments.json` will return a list of all currently fundable patients on Watsi.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"key\",\n \"h-1\": \"description\",\n \"0-0\": \"`profiles`\",\n \"0-1\": \"This will be an array of all fundable profiles on Watsi.\",\n \"1-0\": \"\",\n \"1-1\": \"\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]\nEach profile will have the following keys:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Value (Example)\",\n \"h-2\": \"Description\",\n \"0-0\": \"token\",\n \"0-1\": \"**String** (\\\"69a1b67ff206\\\")\",\n \"0-2\": \"The token of the profile (use the `/profile/:token` endpoint to get additional details)\",\n \"1-0\": \"name\",\n \"1-1\": \"**String** (\\\"Julie\\\")\",\n \"1-2\": \"The first name of the patient\",\n \"3-0\": \"age_years\",\n \"3-1\": \"**Integer** (13)\",\n \"3-2\": \"The age of the patient, in years. If the patient is younger than 2, may be blank.\",\n \"6-0\": \"country\",\n \"6-1\": \"**String** (\\\"Nepal\\\")\",\n \"7-0\": \"url\",\n...