Changes for page API V2.0

Last modified by Treyfane Dingo on 2024/03/10 02:07

From version 2.1
edited by Treyfane Dingo
on 2023/05/27 01:28
Change comment: There is no comment for this version
To version 9.1
edited by Treyfane Dingo
on 2024/02/11 19:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API V1.0
1 +API V2.0
Parent
... ... @@ -1,1 +1,1 @@
1 -L\.A\.S\.S\.I\.E\..WebHome
1 +L\.A\.S\.S\.I\.E\..System Information.WebHome
Content
... ... @@ -1,6 +1,6 @@
1 -The L.A.S.S.I.E. API V 1.0 can be reached via
1 +The L.A.S.S.I.E. API V 2.0 can be reached via
2 2  
3 -{{{https://www.furcom.org/api/lassie/v1.0}}}
3 +{{{https://api.lassie.online/v2.0}}}
4 4  
5 5  === Required POST Parameters ===
6 6  
... ... @@ -10,7 +10,7 @@
10 10  * request
11 11  * command (optional)
12 12  
13 -The API-Key has to be set in "System Settings". Preferrably a longer and unique key (like a MD5SUM).
13 +The API-Key has to be set in "System Settings" → "API Keys". Preferrably a longer and unique key (like a MD5SUM). An specific API key can only be used for a corresponding request type.
14 14  
15 15  (% style="width:50%" %)
16 16  |=(% colspan="3" %)Requests and Commands
... ... @@ -25,14 +25,23 @@
25 25  
26 26  === Example (CURL) ===
27 27  
28 -{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" https://www.furcom.org/api/lassie/v1.0}}}
28 +{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" https://api.lassie.online/v2.0}}}
29 29  
30 30  This example will display the entire Lost & Found Database of FTC.
31 31  
32 -{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" -d "command=lost" https://www.furcom.org/api/lassie/v1.0}}}
32 +{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" -d "command=lost" https://api.lassie.online/v2.0}}}
33 33  
34 34  This example will display only the lost items of the Lost & Found Database of FTC.
35 35  
36 +=== Test API Keys ===
37 +
38 +The API Keys for FurtherTestCon (FTC) are:
39 +
40 +{{{ae629a834729fd3aac6d1f827b1793b2 Attendee Database
41 +ae629a834729fd3aac6d1f827b1793b1 Operatives Database
42 +ae629a834729fd3aac6d1f827b1793b0 Lost & Found Database
43 +ae629a834729fd3aac6d1f827b1793b3 Briefings Database}}}
44 +
36 36  === Output ===
37 37  
38 38  The output of an valid request to the API will be a JSON-Object like the following examples:
... ... @@ -40,7 +40,7 @@
40 40  ==== Lost & Found Database ====
41 41  
42 42  {{box}}
43 -{"data":[{"id":"1","image":"https:\/\/www.furcom.org\/lassie\/images\/lostandfound_db\/9a7a1039bcbe887ed2f57a5b64c56c51.png","title":"A Piece of Cake","description":"Just another piece of cake","status":"F","lost_timestamp":"","found_timestamp":"2021-06-22 19:08:16","return_timestamp":""}]}
52 +{"data":[{"id":1925,"image":null,"thumb":null,"title":"Image","description":"invisible, watercolour, found in Schroedinger's box","status":"F","lost_timestamp":null,"found_timestamp":"2023-11-24 00:27:24","return_timestamp":null},{"id":1921,"image":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/fe3c6670a33d8f4199ffa95a5c23b622.png","thumb":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/thumbnail\/fe3c6670a33d8f4199ffa95a5c23b622.png","title":"Sense of Taste","description":"lost in Hotel Restaurant","status":"L","lost_timestamp":"2023-11-01 16:13:02","found_timestamp":null,"return_timestamp":null},{"id":1920,"image":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/bc7c343fb3807d4d41b7e04fa909aad5.png","thumb":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/thumbnail\/bc7c343fb3807d4d41b7e04fa909aad5.png","title":"Vape","description":"black \/ rainbow, \"GEEKVAPE\", found at Open Stage","status":"F","lost_timestamp":null,"found_timestamp":"2023-09-30 23:52:38","return_timestamp":null}]}
44 44  {{/box}}
45 45  
46 46  (% style="width:50%" %)
... ... @@ -48,6 +48,7 @@
48 48  |=(% scope="col" %)Key|=Field|=NULL
49 49  |id|Numeric value, PRIMARY KEY|-
50 50  |image|URL|null
60 +|thumb|URL|null
51 51  |title|Text|empty string
52 52  |description|Text|empty string
53 53  |status|L ~| F ~| R (Lost, Found or Returned)|-
... ... @@ -58,7 +58,7 @@
58 58  ==== Briefings Database ====
59 59  
60 60  {{box}}
61 -{"data":[{"id":"17","class":"P","topic":"UPDATE - Security News 21.12.2021","content":"<div id=\"briefing_content_content\"><div><b>Germany cancelled New Years Eve<\/b><\/div><div>Although it might calendar wise be unwise, Germany just cancelled New Years Eve. Further information can be obtained elsewhere.<\/div><div><br><\/div><div><b>Some things found<\/b><\/div><div>Security\r\n wants to remind all attendees that information about lost or found \r\nitems can be obtained via the APP or the Website of the convention. Lost\r\n &amp; Found is maintained by security and located in the security \r\noffice.<\/div><div><br><\/div><div><b>Quote of the day<\/b><\/div><div>\"Where is your neighbor?\"<\/div><div>\"He's in the garden ...\"<\/div><div>\"I can't see him ...\"<\/div><div>\"Oh, you'd have to dig quite a bit ...\"<br><\/div><div><br><\/div><\/div>","ops_id":"112","datetime_creation":"2021-12-21 22:19:45","datetime_lastchange":"","datetime":"2021-12-21 22:19:45"}]}
71 +{"data":[{"id":"17","class":"P","topic":"UPDATE - Security News 21.12.2021","content":"<div id=\"briefing_content_content\"><div><b>Germany cancelled New Years Eve<\/b><\/div><div>Although it might calendar wise be unwise, Germany just cancelled New Years Eve. Further information can be obtained elsewhere.<\/div><div><br><\/div><div><b>Some things found<\/b><\/div><div>Security\r\n wants to remind all attendees that information about lost or found \r\nitems can be obtained via the APP or the Website of the convention. Lost\r\n &amp; Found is maintained by security and located in the security \r\noffice.<\/div><div><br><\/div><div><b>Quote of the day<\/b><\/div><div>\"Where is your neighbour?\"<\/div><div>\"He's in the garden ...\"<\/div><div>\"I can't see him ...\"<\/div><div>\"Oh, you'd have to dig quite a bit ...\"<br><\/div><div><br><\/div><\/div>","ops_id":"112","datetime_creation":"2021-12-21 22:19:45","datetime_lastchange":"","datetime":"2021-12-21 22:19:45"}]}
62 62  {{/box}}
63 63  
64 64  (% style="width:50%" %)