Difference between revisions of "Check Key"
From MyMobileWorkers API
(→Example curl request) |
m (→Summary) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
|- | |- | ||
! URL | ! URL | ||
| − | | colspan="2" | | + | | colspan="2" | https://:base_url/:api_path/:version/companies/company/test_key |
|- | |- | ||
! Type | ! Type | ||
| 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 == | ||
| Line 33: | Line 33: | ||
== Example curl request == | == Example curl request == | ||
| − | + | https://api.mymobileworkers.com:8181/api/1/companies/company/test_key?api_key=YOURAPIKEY | |
Latest revision as of 09:59, 29 March 2018
Contents |
[edit] Summary
| Check API Key | ||
|---|---|---|
| URL | https://: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.
[edit] Example response
[edit] Valid
{"success_message":"key is valid"}
[edit] Invalid
{"error_code":"AUT002","error_message":"Authentication failed. Api key is incorrect."}
[edit] Example curl request
https://api.mymobileworkers.com:8181/api/1/companies/company/test_key?api_key=YOURAPIKEY
