API

Die meisten APIs sind nicht dokumentiert (auch wenn Sie anhand des Codes verstehen können, wie sie funktionieren…), da sie aus Sicht eines Clients nicht relevant sind und nur zur Kommunikation zwischen dem Frontend und dem Backend verwendet werden.

Hier sind die APIs, die wir zu dokumentieren beschlossen haben, die wirklich nützlich sind, wenn Sie Ihren eigenen Client erstellen möchten, der mit einem Yed-Server arbeitet. Um eine API aufzurufen, verwenden Sie diese Vorlagen-URL: http://youryedserver.xyz/api.php?action=theapi&token=yourapikey&param1=value&param2=value&param

scanfile

POST
http://localhost/api.php?token=my_token&action=scanfile
description:
Scans a file with the current publication
parameters:
$_FILES=the_file_scan (only first item taken)
return data: 
JSON results of matches

downloadpublication

GET
http://localhost/api.php?token=my_token&action=downloadpublication
description:
Downloads a publication package locally
parameters:
id=the_publication_id (retrieved with checkpackageversion)
public_link=true|false (if true, zip extension is hidden)
encrypted=true|false (if true, encrypted package is served, see config)
return data: 
Redirection to file or text error

checkpackageversion

GET
http://localhost/api.php?token=my_token&action=checkpackageversion
description:
Check if current package version is outdated
parameters:
version=current_version
beta=true|false (if true, takes in account publications in "Test")
return data: 
JSON results with if outdated, and last version / publication id