Check Key

From MyMobileWorkers API
Revision as of 12:53, 14 November 2016 by Ian (Talk | contribs)

Jump to: navigation, search

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

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox