Es gibt Neuigkeiten zu dem Short-URL-Dienst twiturl.de von Malte und mir. Ab sofort geben wir unsere API für den Testbetrieb frei. Ihr könnt die API also direkt für eure Programme und Plugins nutzen. Die wichtigsten Fakten sind jetzt hier in der FAQ zusammengefasst:
1. Wie erreiche ich die API?
http://api.twiturl.de/friends.php
2. Wie übergebe ich die Parameter an die API?
Die Variablen new_url (nötig) und new_code (optional) stehen derzeit zur Verfügung. Sie können per POST und GET Methode übergeben werden.
3. Was übergebe ich mit der Variable new_url?
Das ist die lange URL, die in eine Twiturl umgewandelt werden soll. Bitte komplett mit http:// übergeben.
4. Was übergebe ich mit der Variable new_code?
Hier kann ein Wunschcode übergeben werden. Ist dieser Code noch nicht in Benutzung, wird die lange URL künftig unter http://twiturl.de/wunschcode erreichbar sein.
5. Wie erhalte ich meine neue Twiturl?
Das Ergebnis des Aufrufs der API-URL (siehe Frage 1) wird im RSS 2.0 Format dargestellt. Im Linkfeld des ITEMS steht die neue Twiturl-Adresse und im Titelfeld wird der Code angezeigt. Hier ein Beispiel:
6. Wie werden Fehler angezeigt?
Gibt es einen Fehler, wird auch dieser im RSS 2.0 Format dargestellt. Auch dieser kann vom Clienten ausgelesen werden. Fehlermeldungen können mit dem Titelfeld erkannt werden. Im Titel wird „Error“ angezeigt. Die Fehlerbeschreibung steht im Descriptionfeld. Hier ein Beispiel:
7. Gibt es eine Beschränkung der Nutzung?
Derzeit ist die API frei zugänglich. Falls es die Nachfragelast zu stark wird, behalten wir uns Zugangsrestriktionen vor, um einen gerechten API-Zugang zu gewähren.
8. Wie kann ich die Statistik zu meiner Twiturl anzeigen lassen?
Zurzeit bieten wir die Statistiken noch nicht an. Die Statistiken können wie gewohnt unter http://stats.twiturl.de/wunschcode abgerufen werden.
9. Mein Client parst kein RSS. Kann ich den Output auch als Text anzeigen lassen?
Ja! Die Ausgabe kann von RSS 2.0 auf simplen Text umgestellt werden, wenn die Variable output mit dem Inhalt txt übergeben wird. Beispiel: http://api.twiturl.de/friends.php?new_url=http://www.netzeitung.de&output=txt gibt die generierte Twiturl (bzw. die Fehlermeldung) zurück.
10. Wie kann ich auch kodierte URLs übergeben (rawurlencode)?
Du kannst eine kodierte URL übergeben (nach RFC 1738), wenn du die Variable codetype mit dem Wert rawurlencoded übergibst. Beispiel: http://api.twiturl.de/friends.php?new_url=http://www.netzeitung.de&output=txt&codetype=rawurlencode macht es möglich eine kodierte URL zu übergeben, damit es zum Beispiel beim Zeichen & oder ? zu keinen Problemen kommt.
Neuigkeiten zur API werden künftig auch in diesem Blog-Eintrag dokumentiert.
Update:
- Samstag, 10.01.09 um 19:05 Uhr: Output „Text“ hinzugefügt.
- Sonntag, 04.04.10 um 21:55 Uhr: Rawurlencode hinzugefügt.
Links:
- Hier im Blog: Infos zum Start von Twiturl
- Hier im Blog: Neuigkeiten zu Twiturl
- Hier im Blog: RP ONLINE mit Twiturl
Dirk Rudolph meint
Hey. ich versuche gerade eine TwiturlDas extension für Typo3 zu bauen. Dabei ist es möglich, dass z.b. wenn tt_news eingesetzt wird Links mit Zeichen wie & übertragen werden. Ist es möglich, dass ihr bei eurer API rawurlencoeded oder base64 encoded Strings annehmt, so dass es auch mit solchen Seiten keine Probleme gibt? Wird mit Typo3 realurl verwendet geht alles, jedoch ist das nicht immer der Fall.
Viele Grüße
Hallo Dirk,
das ist eine gute Idee! Das werde ich gerne einbauen!! Ich poste das neue API-Release dann hier in den Kommentaren und oben im Beitrag als Ergänzung.
Gruß, Daniel
Hallo Dirk,
ab sofort habe ich die API erweitert und du kannst auch kodierte URLs nutzen - wie - das steht oben im Blogpost - den Teil habe ich ergänzt.
Gruß, Daniel
Dirk Rudolph meint
cool. danke =)