API

Mit der Share-Links API lässt sich das Erstellen von geschützen Ordnern ohne Webseiten Zugriff vollkommen automatisieren und für die eigenen Zwecke verwenden.
Um alle Funktionen nutzen zu können, muss der kostenfrei erhältliche API-Key. genutzt werden, der für jeden angemeldeten Benutzer zur Verfügung steht.

1. Ordner erstellen

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

Die im Anschluss gezeigte Tabelle gibt einen Überblick über alle zur Verfügung stehenden Variablen und die möglichen Antworten der API.

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] * (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen
[folderName] ** (string) Name des Ordners (optional)
[links] (string) Bis zu 500 durch "\n" oder "\r\n" getrennte URLs (ungültige werden ohne Rückmeldung verworfen)
[blinks(1-9)] * (string) Bis zu 500 Backup-URLs PRO Backup-Paket. (1-9): Bis zu 9 Backup-Pakete sind möglich. Die Klammer durch die gewünschte Nummer ersetzen.
[backup] * (boolean) Aktivierung der Backup-Funktion. Nur gültig zusammen mit vorhandenen Backup-Links (ansonsten automatische Deaktivierung)
[backup_mode] * (boolean) '0' = Single-Mode (Dateien werden einzeln getauscht),
'1' = Mutli-Mode (kompletter Austausch aller Links)
[captcha] (boolean) Captcha Abfrage vor jedem Ordner
[pass_user] (boolean) Passwort Abfrage für jeden Benutzer
[pass_admin] *** (boolean) Passwort um den Ordner zu ändern
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) Kommentar für den Ordner. Es können auch komplette NFO-Inhalte verwendet werden.
[non_profit] * (boolean) Wenn aktiviert ("1"), werden keine Punkte mehr vergütet und die Werbeauslieferung auf der Webseite wird auf ein Minimum reduziert. Default: "0"

*ohne API-Key sind nicht alle Funktionen nutzbar
**Übertragung im UTF-8 Charset
***Wird bei Verwendung des API-Keys ignoriert
****Minimal eine Option muss ausgewählt werden

[ 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 ]

Neben aller Dokumentation erleichtern Beispiele das Nutzen und Verstehen oft sehr. Daher wurde an dieser Stelle ein allgemein gültiges HTML-POST-Form veröffentlicht, welches für Jedermann einen leichten Einstieg ermöglichen sollte.

API HTML-POST-Form Beispiel anzeigen.

<!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 ]

Sollte es bei der Nutzung der API zu Problemen kommen, steht der Support sowohl per Email wie auch im Forum zu jeder Zeit gerne zur Verfügung.
Einige Anregungen sind zusätzlich in der FAQ zusammengefasst.

1.1 Ordner editieren

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

Die Benutzung der Editierfunktion ist zu 100% identisch mit der unter 1. Ordner erstellen erklärten Erstellung von Ordnern.
Lediglich die URL ist wie beschrieben verändert und die Variablen Menge ist frei wählbar. Jedes nicht übermittelte Detail wird aus dem bestehenden Ordner übernommen, vorhandene durch neu übertragene ersetzt. Links und Backuplinks müssen immer zusammen übertragen werden, nicht übermittelte und ursprünglich vorhandene Backups werden ersetzt und gelöscht!

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen
[folderCode] (string) Dieser Wert gibt den zu editieren Ordner an. Es ist der einzige notwendige zusätzliche Parameter, alle anderen sind von 1. Ordner erstellen zu übernehmen.

1.2 Inhalt ausgeben

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

Gibt alle Links des Ordners aus

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen
[folderCode] (string) Dieser Wert gibt den zu editieren Ordner an. Es ist der einzige notwendige zusätzliche Parameter, alle anderen sind von 1. Ordner erstellen zu übernehmen.

[ API-RESPONSE ]

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

1.3 Ordner Liste

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen

[ API-RESPONSE ]

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

2. Ordner löschen

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

Die im Anschluss gezeigte Tabelle gibt einen Überblick über alle zur Verfügung stehenden Variablen und die möglichen Antworten der API.

[ HTTP-POST-VARIABLES ]

[POST-Variable-Name] (type) POST-Variable-Value
[apikey] * (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen
[folderCode] (string) (string) Code des Ordners
(z.B. "http://share-links.biz/_pwuzernxawe/folderName" = "pwuzernxawe")
[pass_admin] ** (boolean) Passwort um den Ordner zu ändern

*ohne API-Key sind nicht alle Funktionen nutzbar
**Nur bei Gast-Ordnern notwendig

[ 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. Ordner Zustand/Status/Information (NUR für registrierte Benutzer!)

[ API-URL ]

Alle im folgenden erklärten Anfragen sind an folgende API-URL via HTTP-GET-Request oder HTTP-POST-Request zu senden

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

Die im Anschluss gezeigte Tabelle gibt einen Überblick über alle zur Verfügung stehenden Variablen und die möglichen Antworten der API.

[ HTTP-GET/POST-VARIABLES ]

[GET/POST-Variable-Name] (type) GET/POST-Variable-Value
[apikey] * (string) Für registrierte Benutzer oben angezeigter Schlüssel um vollen Zugriff auf die API zu erlangen
[folderCodes] (string) Bis zu 100 durch "\n" oder "\r\n" getrennte FolderCodes
(z.B. "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)