Difference between revisions of "Check Key"
From MyMobileWorkers API
(→Example curl request) |
m (→Summary) |
||
| Line 19: | Line 19: | ||
| − | The | + | The Check API Key call provides a quick way to check if the API key is valid 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 == | == Example response == | ||
Revision as of 10:08, 8 June 2017
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 call provides a quick way to check if the API key is valid 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
