User Tools

Site Tools


v0.3

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
v0.3 [2019/02/11 23:16]
kevincross created
v0.3 [2019/02/12 20:09] (current)
kevincross
Line 1: Line 1:
 ====== ChastiKey API (v0.3) ====== ====== ChastiKey API (v0.3) ======
-Based on simple REST principles, the ChastiKey API returns JSON data about a specific users active locks. 
- 
-The ChastiKey API is in its infancy with the latest version (v0.3) still being in an early alpha stage. In order to progress and develop it further your feedback and suggestions are needed. Please discuss here on the forum: https://​www.chastikeyforums.com/​chastikey-chat/​chastikey-api-v0-3 
- 
-Currently the ChastiKey API only returns data, you can’t use it to edit or manipulate locks. 
- 
-URLs are accessed via standard HTTPS requests and start with https://​api.chastikey.com/​. 
  
 ===== ChastiKey API URL ID’s & Parameters ===== ===== ChastiKey API URL ID’s & Parameters =====
-Version 0.of the ChastiKey API has the following two URLs available:+Version 0.of the ChastiKey API has the following two URLs available:
  
 https://​api.chastikey.com/​v0.3/​listlocks.php\\ https://​api.chastikey.com/​v0.3/​listlocks.php\\
Line 44: Line 37:
             "​timestampUnlocked"​ : 0,              "​timestampUnlocked"​ : 0, 
             "​status"​ : "​Locked",​             "​status"​ : "​Locked",​
-            "​combination"​ : 0+            "​combination"​ : ""​
         },          }, 
         {         {
Line 53: Line 46:
             "​timestampUnlocked"​ : 1539287453, ​             "​timestampUnlocked"​ : 1539287453, ​
             "​status"​ : "​UnlockedFake",​             "​status"​ : "​UnlockedFake",​
-            "​combination"​ : 48238191+            "​combination"​ : "48238191"
         },          }, 
         {         {
Line 62: Line 55:
             "​timestampUnlocked"​ : 1539287453, ​             "​timestampUnlocked"​ : 1539287453, ​
             "​status"​ : "​UnlockedReal",​             "​status"​ : "​UnlockedReal",​
-            "​combination"​ : 22029321+            "​combination"​ : "22029321"
         }         }
     ]     ]
Line 75: Line 68:
  
 **locks – combination** **locks – combination**
-This shows the combination attached to the lock, but only if the lock status (see below) is flagged as UnlockedReal or UnlockedFake. Will return ​if not yet unlocked.+This shows the combination attached to the lock, but only if the lock status (see below) is flagged as UnlockedReal or UnlockedFake. Will return ​blank if not yet unlocked.
  
 **locks – lockID** **locks – lockID**
Line 128: Line 121:
             "​timestampUnlocked"​ : 0,              "​timestampUnlocked"​ : 0, 
             "​status"​ : "​Locked",​             "​status"​ : "​Locked",​
-            "​combination"​ : 0+            "​combination"​ : ""​
         }         }
     ]     ]
Line 141: Line 134:
  
 **locks – combination** **locks – combination**
-This shows the combination attached to the lock, but only if the lock status (see below) is flagged as UnlockedReal or UnlockedFake. Will return ​if not yet unlocked.+This shows the combination attached to the lock, but only if the lock status (see below) is flagged as UnlockedReal or UnlockedFake. Will return ​blank if not yet unlocked.
  
 **locks – lockID** **locks – lockID**
v0.3.1549926998.txt.gz · Last modified: 2019/02/11 23:16 by kevincross