API Documentation

API Documentation / Wiki

The following pages provide an overview about all functions of the API (Application Programming Interface) of the hyper Content & Digital Asset Management Server.
Please note, that you might usually only require few functions for the development of Plugins, template functions like navigation, sitemap and so on. Please read the Template Designers Guide and Programers Guide for a better insight.
The API is primarily used for the implementation of standalone applications that leverage the capabilities of the hyper Content & Digital Asset Management Server. The API is not to be confused with the OpenAPI, which is based on a SOA (Service Oriented Architecture), and is not part of the Free Edition.

For Questions & Answers please visit the Google Group.

hyperCMS API Function Reference

  1. Main API Functions
  2. Get API Functions
  3. Set API Functions
  4. Connect API Functions
  5. Security API Functions
  6. Media API Functions
  7. Metadata API Functions
  8. Link API Functions
  9. Plugin API Functions
  10. User Interface API Functions
  11. Template Engine API Functions
  12. XML API Functions
  13. Report API Functions
  14. Project API Functions
  15. Task API Functions
  16. Workflow API Functions
  17. Cloud Storage API Functions
  18. 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
  • $mgmt_config

Output
  • true / false on error


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
  • $mgmt_config

Output
  • true / false on error


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
  • $mgmt_config

Output
  • true / false on error


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
  • $mgmt_config

Output
  • true / false on error


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
  • $mgmt_config

Output
  • true / false on error


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
  • $mgmt_config

Output
  • result array / false on error


createsharelink_facebook


Syntax
createsharelink_facebook ($site, $url)

Input parameters
  • $site ... URL to share [string]
  • $url

global input parameters
  • $mgmt_config

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
  • $mgmt_config

Output
  • Share URL / false on error


createsharelink_googleplus


Syntax
createsharelink_googleplus ($site, $url)

Input parameters
  • $site ... URL to share [string]
  • $url

global input parameters
  • $mgmt_config

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
  • $mgmt_config

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
  • $mgmt_config

Output
  • Share URL / false on error


This website uses cookies to ensure you get the best experience on our website. More info