http://to.vg/api.php
Dabei müssen diese drei Parameter gesetzt werden:apiusr=API-USER
apikey=API-KEY
urlquery=URL
Optional können zwei weitere Parameter gesetzt werden:twmessage=ENCODED-TWITTER_MESSAGE
twuser=ENCODED-TWITTER-USER
D.h. zusammengefasst sieht das dann so aus:http://to.vg/api.php?apiusr=API-USER&apikey=API-KEY&twmessage=ENCODED-TWITTER_MESSAGE&twuser=ENCODED-TWITTER_USER&urlquery=URL
API-USER, API-KEY, URL, ENCODED-TWITTER_MESSAGE und ENCODED-TWITTER-USER müssen logischerweise durch die entsprechenden Parameter ersetzt werden. z.B. könnte ein vollständiger Aufruf in etwa so aussehen (mit Frame):Und ohne Frame-Ansicht:
Wichtig: Die übergebene URL, ENCODED-TWITTER_MESSAGE und ENCODED-TWITTER-USER müssen kodiert übergeben werden. D.h. alle übergebenen Zeichen ausser alphabetischen Zeichen, Dezimalzahlen und - _ . ! ~ * ' ( ) müssen kodiert bzw. escaped sein. Dies kann z.B. in JavaScript durch die Funktion encodeURIComponent bewerkstelligt werden.
Ausserdem ist zu beachten, dass pro 24h pro API-Key erst einmal nur 250 Queries möglich sind. Für viel größere Datenmengen ist es auch möglich, einen kommerziellen API-Schlüssel zu erwerben, der unlimitiert ist.
Hier sind mögliche Fehlercodes, die auftauchen können:
|
"1001# please specify url param." |
Bitte den "urlquery"-Parameter korrekt angeben |
|
"1002# please specify user param." |
Bitte den "apiusr"-Parameter korrekt angeben |
|
"1003# please specify api key param." |
Bitte den "apikey"-Parameter korrekt angeben |
|
"1004# url is invalid." |
Die URL ist ungültig: Bitte nachsehen, ob Sonderzeichen vollständig kodiert sind. |
|
"1005# you have reached your maximum limit of possible api requests. Please wait 24 hours." |
Bitte 24h warten, da das Limit von 250 Requests pro Tag erschöpft ist. Alternative: Kommerzielle, unlimitierte API beantragen. |
|
"1006# api key or user credentials are invalid." |
API-Benutzerdaten sind ungültig: Bitte nachsehen, ob die Parameter vollständig angegeben sind. |
|
"1007# You tried to access the api directly from IP-ADDRESS which is not allowed. This API key is registered to someone else." |
Hier wird geprüft, ob die anfragende IP-Adresse fü die Benutzung des kommerziellen API-Keys legitimiert ist. Bei dieser Warnmeldung sollte geprüft werden, ob der richtige HOST der kommerziellen API-Lizenz eingetragen wurde. "IP-ADDRESS" repräsentiert die anfragende IP-Adresse. |
|
"1008# Your URL sucks. ;-)" |
Anscheinend ist die eingegebene URL ganz schöner Schrott. Und Müll-URLs oder SPAM-Einträge sind hier nicht zugelassen. |
|
"1009# website message (also: twitter message) is longer than 140 chars." |
Die eingegebene Nachricht, die über der Webseite angezeigt werden soll ist zu lang, maximal 140 Zeichen sind erlaubt. |
|
"1010# website message (also: twitter message) can not be empty." |
Die eingegebene Nachricht darf nicht leer sein, wenn ein Benutzername angegeben ist. |
|
"1011# url is already a redirection or short url." |
Die URL benutzt bereits einen redirect oder ist die url ein short url service. Bitte überprüfen Sie die URL einfach auf Longurl.org |
|
"1012# url is blacklisted or contains malware." |
Die URL ist auf einer der folgenden Spam und Malware Blacklists eingetragen: multi.surbl.org / multi.uribl.com / list.anonwhois.net |
Um einen Lizenzschlüssel zu erstellen, füllen Sie bitte einfach das folgende Formular aus: