Difference between revisions of "Check Key"
From MyMobileWorkers API
(Created page with "== Summary == {| border="1" class="wikitable" ! Check API Key ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/companies/company/test_key |- ! T...") |
(→Example curl request) |
||
| Line 33: | Line 33: | ||
== Example curl request == | == Example curl request == | ||
| − | http:// | + | http://api.mymobileworkers.com:8080/api/1/companies/company/test_key?api_key=YOURAPIKEY |
Revision as of 12:53, 14 November 2016
Contents |
Summary
| Check API Key | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/companies/company/test_key | |
| Type | GET | |
| Params: | api_key | required |
| Response | JSON | |
The check api key provides a quick way to check if the api key is a valid one for the MMW system or not. This can be used for debugging or a test in your application before attempting to process jobs.
Example response
Valid
{"success_message":"key is valid"}
Invalid
{"error_code":"AUT002","error_message":"Authentication failed. Api key is incorrect."}
Example curl request
http://api.mymobileworkers.com:8080/api/1/companies/company/test_key?api_key=YOURAPIKEY
