Die folgenden Seiten geben einen Überblick über die Funktionen des API (Programmierschnittstelle) des hyper Content & Digital Asset Management Servers.
Bitte beachten Sie, dass Sie in der Regel nur wenige Funktionen für die Entwicklung von Plugins oder speziellen Template-Funktionen, wie automatische Erstellung einer Navigation, Sitemap und so weiter, benötigen. Bitte studieren Sie den Template Designers Guide und Programers Guide für eine bessere Einsicht in die Handhabung dieser Funktionen.
Das API dient primär für die Umsetzung eigenständiger Anwendungen, die die Funktionen des hyper Content & Digital Asset Management Servers nutzen. Das API ist nicht mit dem OpenAPI zu verwechseln, welchen auf einer SOA (Service Oriented Architecture) basiert und nicht Bestandteil der Free Edition ist.
Fragen und Antworten bitte innerhalb der Google Group.
hyperCMS API Function Reference
- Main API Functions
- Get API Functions
- Set API Functions
- Connect API Functions
- Security API Functions
- Media API Functions
- Metadata API Functions
- Link API Functions
- Plugin API Functions
- User Interface API Functions
- Template Engine API Functions
- XML API Functions
- Report API Functions
- Project API Functions
- Task API Functions
- Workflow API Functions
- Cloud Storage API Functions
- Import/Export API Functions
▲ Connect API Functions
ftp_userlogon
Description
This function connects and performs logon to an FTP server.
Syntax
ftp_userlogon ($server, $user, $passwd, $ssl=false)
Input parameters
- $server ... FTP servername or IP [string]
- $user ... user name [string]
- $passwd ... password [string]
- $ssl ... SSL [boolean] (optional)
global input parameters
Output
ftp_userlogout
Description
This function disconnects from an FTP server.
Syntax
ftp_userlogout ($conn_id)
Input parameters
- $conn_id ... FTP connection [resource]
global input parameters
Output
ftp_getfile
Description
This function gets a file from the FTP server.
Syntax
ftp_getfile ($conn_id, $remote_file, $local_file, $passive=true)
Input parameters
- $conn_id ... FTP connection [resource]
- $remote_file ... path to file on FTP server [string]
- $local_file ... passive mode [boolean] (optional)
- $passive
global input parameters
Output
ftp_putfile
Description
This function puts a file to the FTP server.
Syntax
ftp_putfile ($conn_id, $local_file, $remote_file, $passive=true)
Input parameters
- $conn_id ... FTP connection [resource]
- $local_file ... path to local file [string]
- $remote_file ... path to file on FTP server [string]
- $passive ... passive mode [boolean] (optional)
global input parameters
Output
ftp_deletefile
Description
This function deletes a file from the FTP server.
Syntax
ftp_deletefile ($conn_id, $remote_file, $passive=true)
Input parameters
- $conn_id ... FTP connection [resource]
- $remote_file ... path to file on FTP server [string]
- $passive ... passive mode [boolean] (optional)
global input parameters
Output
ftp_filelist
Description
This function gets a file/directory listing of the FTP server.
Syntax
ftp_filelist ($conn_id, $path=".", $passive=true)
Input parameters
- $conn_id ... FTP connection [resource]
- $path ... path to remote directory [string] (optional)
- $passive ... passive mode [boolean] (optional)
global input parameters
Output
- result array / false on error
createsharelink_facebook
Syntax
createsharelink_facebook ($site, $url)
Input parameters
- $site ... URL to share [string]
- $url
global input parameters
Output
- Share URL / false on error
createsharelink_twitter
Syntax
createsharelink_twitter ($site, $url, $text)
Input parameters
- $site ... URL to share [string]
- $url ... message to share [string]
- $text
global input parameters
Output
- Share URL / false on error
createsharelink_googleplus
Syntax
createsharelink_googleplus ($site, $url)
Input parameters
- $site ... URL to share [string]
- $url
global input parameters
Output
- Share URL / false on error
createsharelink_linkedin
Syntax
createsharelink_linkedin ($site, $url, $title, $summary, $source)
Input parameters
- $site ... URL to share [string]
- $url ... title [string]
- $title ... summary [string] (optional)
- $summary ... source [string] (optional)
- $source
global input parameters
Output
- Share URL / false on error
createsharelink_pinterest
Syntax
createsharelink_pinterest ($site, $image_url, $title, $description)
Input parameters
- $site ... image URL to share [string]
- $image_url ... title [string]
- $title ... description [string] (optional)
- $description
global input parameters
Output
- Share URL / false on error