API

La plupart des API ne sont pas documentées (même si vous pouvez comprendre leur fonctionnement à partir du code…) car elles ne sont pas pertinentes du point de vue du client et servent uniquement à la communication entre le front-end et le back-end.

Voici celles que nous avons décidé de documenter, qui sont vraiment utiles si vous prévoyez de créer votre propre client fonctionnant avec un serveur Yed. Pour appeler une API, utilisez ce modèle d'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