API

La mayoría de las APIs no están documentadas (aunque puede entender cómo funcionan a partir del código…) porque no son relevantes desde el punto de vista de un cliente, y solo se utilizan para la comunicación entre el front-end y el back-end.

Estas son las que decidimos documentar, que son realmente útiles si tiene previsto crear su propio cliente que funcione con un servidor Yed. Para llamar a una API, utilice esta url de plantilla: 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