API

With the Share-Links-API it is possible to create protected folders with fully automated websites and use them for your own purposes.
To use all functions you will need the free available API-Key which is shown on the top of this page to every registered user.

1. Create Folder

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/insert

The following table provides an illustrated overview of all available variables and the possible answers of the API.

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] * (string) For registered users in combination with the above shown API-Key
[folderName] ** (string) Foldername (optional)
[links] (string) Up to 500 divided by "\n" or "\r\n" URLs (invalid URLs will be removed without responce)
[blinks(1-9)] * (string) Up to 500 Backup-URLs PER Backup-Package. (1-9): Up to 9 Backup-Packages are usable. Replace the brackets with the desired number.
[backup] * (boolean) Activate the Backup-Function. Only valid in combination with backup-links (otherwise automatical deactivation)
[backup_mode] * (boolean) '0' = Single-Mode (single link replacement),
'1' = Mutli-Mode (complete backup-package exchange)
[captcha] (boolean) Captcha request in front of every folder
[pass_user] (boolean) Password request to user
[pass_admin] *** (boolean) Administration password
Container/Protection: ****

[c_web]
[c_dlc]
[c_cnl]
[c_ccf]
[c_rsdf]
(boolean)

Web-Form-Security
DLC - Container Format
Click'n'Load (v2)
CCF Container Format
RSDF Container Format
[comment] * (string) Comment for the folder. Also NFO-Files are valid.
[non_profit] * (boolean) If activated ("1") the usage of advertisements will be reduced to a lower amount and the page looks much cleaner. The complete point earnings are disabled in this mode. Default: "0"

*without API key, not all features are available
**transmission in the UTF-8 charset
***ignored when using the API Key
****at least one option must be selected

[ API-RESPONSE ]

type / [POST-Variable-Name] Message
invalid [apikey] *** FATAL: invalid API-key. Stopping now ***
no/invalid [links] *** FATAL: no links found. Stopping now ***
active [backup] but no [blinks(1-9)] *** NOTICE: no backups found. Working further ***
[links] and [blinks(1-9)] have unequal link count *** NOTICE: single backup-mode impossible. Working further ***
no/invalid [pass_admin] (for guests only) *** FATAL: admin password required for guests. Stopping now ***
no selected [container] *** FATAL: no container selected. Stopping now ***
[c_cnl] selected but no [c_dlc] *** NOTICE: cnl requires dlc. Working further ***
   
SUCCESS URL: http://share-links.biz/_foldercode ([a-z0-9])

[ HTTP-POST-FORM-EXAMPLE ]

Besides all documentation, examples can enhance the understanding progress very much. Therefore a generally valid HTML POST FORM is published at this point, which should allow an easy transition for everyone.

Show API HTML POST Form sample.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Share-Links - API Example</title>
</head>
<body>
<form method="post" action="http://share-links.biz/api/insert">
<h1>Share-Links - API-Example</h1>
<label for="apikey">API-Key: (*)</label>
            <input type="text" name="apikey" id="apikey" />
            <br /><br />
<label for="folderName">Foldername <small>(UTF-8!!!)</small>: </label>
            <input type="text" name="folderName" id="folderName" />
            <br /><br />
<label for="links">Main-Links: </label>
            <textarea name="links" id="links" cols="40" rows="3">http://www.yourlinks.here/
</textarea>
            <br /><br />
Backup/Mirrors: (*)
            <input type="radio" name="backup" id="backupOff" value="0" />
            <label for="backupOff">Off</label>
            <input type="radio" name="backup" id="backupOn" value="1" />
            <label for="backupOn">On</label>
            <br /><br />
Backup-Mode: (*)
            <input type="radio" name="backup_mode" id="backup_mode_single" value="0" />
            <label for="backup_mode_single">Single</label>
            <input type="radio" name="backup_mode" id="backup_mode_multi" value="1" />
            <label for="backup_mode_multi">Multi</label>
            <br /><br />
Captcha:
            <input type="radio" name="captcha" id="captcha_off" value="0" />
            <label for="captcha_off">Off</label>
            <input type="radio" name="captcha" id="captcha_on" value="1" />
            <label for="captcha_on">On</label>
            <br /><br />
<label for="pass_user">User-Password <small>(only "clean" chars)</small>: </label>
            <input type="text" name="pass_user" id="pass_user" /><br /><br />
<label for="pass_admin">Admin-Password <small>(only "clean" chars)</small> (**): </label>
            <input type="text" name="pass_admin" id="pass_admin" /><br /><br />
<label for="blinks1">Backup-Links #1: (*)</label>
            <textarea name="blinks1" id="blinks1" cols="40" rows="3">http://www.yourbackupslinks.here/1
</textarea>
            <br /><br />
<label for="blinks2">Backup-Links #2: (*)</label>
            <textarea name="blinks2" id="blinks2" cols="40" rows="3">http://www.yourbackupslinks.here/2
</textarea>
            <br /><br />
<label for="comment">Comment <small>(UTF-8!!!) </small>: (*)</label>
            <textarea name="comment" id="comment" cols="40" rows="3">Your comment or NFO-file here
</textarea>
            <br /><br />
Container:  <input type="checkbox" name="c_web" id="c_web" value="1" /> <label for="c_web"> WEB</label>
            <input type="checkbox" name="c_dlc" id="c_dlc" value="1" /> <label for="c_dlc"> DLC</label>
            <input type="checkbox" name="c_cnl" id="c_cnl" value="1" /> <label for="c_cnl"> CNL</label>
            <input type="checkbox" name="c_ccf" id="c_ccf" value="1" /> <label for="c_ccf"> CCF</label>
            <input type="checkbox" name="c_rsdf" id="c_rsdf" value="1" /> <label for="c_rsdf"> RSDF</label>
            <br /><br /><br /><br />
<input type="submit" value="insert" />
</form>
<br /><br />
(*) An own API-Key is available for every registered user. Some features are only available with this key.
<br />
(**) Useless as registered user.
</body>
</html>
                        

[ TROUBLESHOOTING ]

If you have problems with the usage of this API, you can contact the support, both by Email as well as in the Forum any time you may have.
Some suggestions are written down inside the FAQ.

1.1 Edit Folder

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/edit

All parameters of the edit feature are identical to the creation function (1. Create Folder).
The API URL is of cause different, all other paramaters are usable in any combination you want to. Every transmitted detail will replace the existent one (within the folder), every missing one will be fetched from the original folder. Backup links have to my transmitted together with the main links, a separate handling is not possible!

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) For registered users in combination with the above shown API-Key
[folderCode] (string) This values is the only extra required one. All others can be fetched from "1. Create Folder".

1.2 Get the content

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/content

Returns all hyperlinks of this folder

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) For registered users in combination with the above shown API-Key
[folderCode] (string) This values is the only extra required one. All others can be fetched from "1. Create Folder".

[ API-RESPONSE ]

CSV-Output URL;filename;filesize;provider_shortcut;backup_number;status

1.3 Folder list

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/list

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) For registered users in combination with the above shown API-Key

[ API-RESPONSE ]

CSV-Output ID;foldername;provider_shortcut(s);foldersize;clicks;status

2. Remove Folder

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/remove

The following table provides an illustrated overview of all available variables and the possible answers of the API.

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] * (string) For registered users in combination with the above shown API-Key
[folderCode] (string) (string) folder code
(e.g. "http://share-links.biz/_pwuzernxawe/folderName" = "pwuzernxawe")
[pass_admin] ** (boolean) Administration password

*without API key, not all features are available
**Only used for guest folders

[ API-RESPONSE ]

type / [POST-Variable-Name] Message
invalid [apikey] *** FATAL: invalid API-key. Stopping now ***
invalid folderCode *** FATAL: invalid folderCode. Stopping now ***
no/invalid password for guests *** FATAL: invalid admin password. Stopping now ***
Folder NOT deleted folder was not deleted
SUCCESS Folder [folderCode] was deleted

3. Folder Status/Information (ONLY for registered users!)

[ API-URL ]

All requests are explained in the following API Overview which have to be sent to the following URL via HTTP GET or POST request

http://share-links.biz/api/status

The following table provides an illustrated overview of all available variables and the possible answers of the API.

[ HTTP-GET/POST-VARIABLES ]

[GET/POST-Variable-Name] (type) GET/POST-Variable-Value
[apikey] * (string) For registered users in combination with the above shown API-Key
[folderCodes] (string) Up to 100 by "\n" or "\r\n" separated FolderCodes
(e.g. "http://share-links.biz/_pwuzernxawe/folderName" = "pwuzernxawe")
(use";" instead if "\r\n" for GET)

[ API-RESPONSE ]

type / [GET/POST-Variable-Name] Message
too many folderCodes *** FATAL: only [number] folders are allowed to be checked at once Stopping now ***
empty folderCodes *** FATAL: no folderCodes given. Stopping now ***
no error, but no result, too no matching folders found
SUCCESS 07tospkj1ilq;;unknown;1;1;1;1;web;1252652443;1257241395;0

[ EXPLANTION FOR SUCCESSFUL RESPONSE ]

Reponse: "07tospkj1idlq;linktogoogle;parts;2;3;6;7;rs;1252652443;1257241395;17"

Value Explanation
07tospkj1idlq folderCode
linktogoogle folderName
parts folderStatus, possible are "online", "offline", "parts" (partial) and "unknown"
2;3;6;7; 2 links online of all links "without backups"
3 links inside this folder "without backups"
6 links online of all links "with backups"
7 links inside this folder "without backups"
rs detected hoster for this folder, in this case "rs" for "rapidshare.com"
1252652443 folder creation date as unix timestamp
1257241395 last access as unix timestamp
17 counted clicks for this folder (clicks were converted into your earned points and are NOT the accesses to this folder)