Check Key

From MyMobileWorkers API
Jump to: navigation, search

Contents

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.

Example response

Valid

{"success_message":"key is valid"}

Invalid

{"error_code":"AUT002","error_message":"Authentication failed. Api key is incorrect."}

Example curl request

https://api.mymobileworkers.com:8181/api/1/companies/company/test_key?api_key=YOURAPIKEY

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox