Check Key - Revision history

Paul: /* Summary */

2018-03-29T09:59:12Z

‎Summary

Paul: https

2018-03-29T09:58:52Z

https

PaulG: /* Summary */

2017-06-08T10:08:40Z

‎Summary

Ian: /* Example curl request */

2016-11-14T12:53:11Z

‎Example curl request

Ryanmt: 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..."

2013-05-15T10:53:19Z

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..."

New page

== Summary ==
{| border="1" class="wikitable"

! Check API Key
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/companies/company/test_key
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
! Response
| colspan="2" | 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 ===
<source lang="java">
{"success_message":"key is valid"}
</source>
=== Invalid ===
<source lang="java">
{"error_code":"AUT002","error_message":"Authentication failed. Api key is incorrect."}
</source>

== Example curl request ==

http://live.mymobileworkers.com:8080/api/1/companies/company/test_key?api_key=YOURAPIKEY

← Older revision		Revision as of 09:58, 29 March 2018
Line 33:		Line 33:
	== Example curl request ==		== Example curl request ==

−	~~http~~://api.mymobileworkers.com:~~8080~~/api/1/companies/company/test_key?api_key=YOURAPIKEY	+	https://api.mymobileworkers.com:8181/api/1/companies/company/test_key?api_key=YOURAPIKEY

← Older revision		Revision as of 10:08, 8 June 2017
Line 19:		Line 19:


−	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.	+	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 ==

← Older revision		Revision as of 12:53, 14 November 2016
Line 33:		Line 33:
	== Example curl request ==		== Example curl request ==

−	http://~~live~~.mymobileworkers.com:8080/api/1/companies/company/test_key?api_key=YOURAPIKEY	+	http://api.mymobileworkers.com:8080/api/1/companies/company/test_key?api_key=YOURAPIKEY

@@ Line 6: / Line 6: @@
 |-
 ! URL
-| colspan="2" |  http://:base_url/:api_path/:version/companies/company/test_key
+| colspan="2" |  https://:base_url/:api_path/:version/companies/company/test_key
 |-
 ! Type