Support | Kontakt | Suche
 

WEBFAN FAQ (Häufige Fragen und Antworten)




Bereich: Start -> API und Entwickler

Frage
·  API - Was ist das und was bietet Webfan.de?
·  Funktionen - Welche Dienste und Features sind konkret verfügbar?

Sollte hier eine Frage nicht beantwortet sein, dann Klicken Sie Hier um sie hinzuzufügen

Antwort

·  API - Was ist das und was bietet Webfan.de?
Was ist API?
API steht hier als Abkürzung für "Applications Programming Interface". Zu deutsch "Programmierschnittstelle".
Wikipedia Artikel: http://de.wikipedia.org/wiki/Programmierschnittstelle


Die Webfan API Interfaces:
Webfan bietet an verschiedenen Stellen die Möglichkeit Drittsoftware oder eigene Applikationen oder Software mit Webfan Diensten "zu verbinden", in der Regel bedeutet dies bei Webfan die Interaktion zwischen Webseiten.

Die Webfan API Kategorien
Es werden von Webfan.de verschiedene Interaktionsmöglichkeiten für fremde/Deine eigene Software bereitgestellt, welche verschiedene Dienste für verschiedene Kontexte anbieten. Technisch betrachtet lassen sich die Webfan API-Schnittstellen in verschiedene API-Kategorien einordnen. Damit es nicht zur Verwechselung zwischen den API-Versionen (gleiche Versionsnummern unterschiedlicher Software) kommt, wurde beschlossen, die API-Kategorien mit Buchstaben zu indizieren, und die einzelnen aktuellen Versionen der verscheidenen jeweiligen Dienst-Kategorien entsprechend mit Versionsnummern.

API-Kategorien:
  • Api-A::Version=18.23 - DEPRECATED - (diese Schnittstelle ist veraltet und sollte für neue Projekte nicht mehr benutzt werden!)  FREE API-A ist die erste Webfan-API-Kategorie derzeit in der Version 18.23 im Einsatz.
    Diese Schnittstelle ermöglicht das gegenseitige Übermitteln von Kleinanzeigen unter den teilnehmenden Kleinanzeigenmarkt-Applikationen, sowie den Austausch von Weblinkeinträgen unter Webkatalogen. Dem Endbenutzer wird damit die automatische Veröffentlichung seiner Einträge auf allen teilnehmenden Internetseiten ermöglicht.
    Die Benutzung dieser Schnittstelle ist kostenlos.
    Unter folgendem Link ist eine kleine Dokumentation verfügbar: http://www.webfan.de/Content-cid-API-Dokumentation-9.html
    Unter folgendem Link ist eine Liste der teilnehmenden Anwendungen/Internetseiten verfügbar: http://www.webfan.de/API.html#teilnehmer
  • API-B::Version=API-A BIZ API  KOSTENPFLICHTIG API-B benutzt teilweise den Server von API-A und ist eine kostenpflichtige API Erweiterung. BIZ API ermöglicht die Kommunikation von Onlineshops des Webfan Homepagesystems mit beliebiger Drittsoftware. So können zum Beispiel Daten von neuen Bestellungen an Ihre Drittsoftware automatisch übermittelt werden, oder die Buchungen und Leistungsaktivierungen. So kann Ihre Drittsoftware beispielweise automatisch Leistungen für den Kunden freischalten oder andere Aktionen vornehmen. Für den Onlineshop können (z.B. bei Bestellung)  individuelle Formularfelder eingerichtet werden, die ebenfalls an Ihre Drittsoftware per BIZ API übermittelt werden können. Technisch ist BIZ API eine Erweiterung von API-A, ermöglicht jedoch unter anderem zusätzlich das Validieren der Requests über Checksummen und Revalidierungsrequests/Pingbacks. Eine kleine Dokumentation ist unter folgendem Link verfügbar: http://tillwehowski.webfan.de/biz-api-+-asp-dokumentation.kat-39.html Der folgende Link führt zum Webfan Onlineshop wo Sie den Homepagesystem Onlineshop mit BIZ API Account kaufen können: http://domainundhomepagespeicher.webfan.de/shop/onlineshop-mit-asp-und-biz-api-account.39.html
  • API-C::Version=Fremdanbieter deprecated
  • API-D::Version=1 javascript libraries, testing design patterns, preparing for webdof library...
  • interfaces::Version=dyn-dev RESTlike supports multiple formats like js,json,xml,dat,bin,zip
  • frdl::Version=dev create websites, developing projects
  • REST All APIs RESTful interfaces descriptions
  • frdl/OAuth Access the frdl/webfan API functionallities following the OAuth 2.0 protocoll specifications.
    OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices.



·  Funktionen - Welche Dienste und Features sind konkret verfügbar?

Im folgenden sind einige der bestehenden Funktionen der Webfan APIs und der Webfan Web Services aufgelistet.

frdl API

Service Teilnahme Info & Doku Beschreibung API
REST endpoints /http://www.webfan.de/API.html RESTful API description API Endpoints description. Access the several servers. REST
OAuth /http://www.webfan.de/API.html OAuth 2.0 API Documentation (ToDo) Build your own modern frdl/webfan Apps. frdl/OAuth

interfaces API

Service/Funktion Teilnahme Info & Doku Beschreibung FLAG/Dienstkategorie API
API Metadata Discovery /v1/public/help/api/endpoints.json List of main API-Endpoints... List of the Endpoints, Resources and Functions available. (incomplete) documentation, discovery interfaces
Source Repository Download Installer Package
Downloads
...todo..
Example class file source
source and code distribution installation, packaging, repository, rpc interfaces
OAuth Client Homepagesystem Mehr lesen... Mit dem Homepagesystem OAuth Client kannst Du Deiner Homepage ganz einfach und ohne tiefergehende Programmierkenntnisse ein Drittanbieterlogin hinzufügen, z.B. für Facebook, Twitter, Google, Xing, und sonstige Anbieter, welche das OAuth Protokoll unterstützen. Homepagesystem, OAuth, Sonstiges interfaces

 

API-D

Service/Funktion Teilnahme Info & Doku Beschreibung FLAG/Dienstkategorie API
Actvity Stream public 1.3.6.1.4.1.37553.8.1.8.3.8.1.1 Der Activity Stream zeichnet die Aktivitäten auf der Webfan Internetseite auf und macht sie zur Weiterverarbeitung verfügbar.
Die Daten können über einen einfachen GET Request abgerufen werden, die Schnittstelle unterstützt die Angabe von Pagination-Parametern und die Ausgabe der Daten im XML und JSON Format.
Social Network API-D
Community Activity Stream public 1.3.6.1.4.1.37553.8.1.8.3.8.1.1 Mit dem GET Parameter uid=0 können die Aktivitäten aller Mitglieder auf der gesamten Webfan Internetseite abgerufen werden. Social Network API-D
Personal Activity Stream public 1.3.6.1.4.1.37553.8.1.8.3.8.1.1 Mit der Angabe einer Webfan-Benutzer-ID als GET Parameter können die Aktivitäten eines bestimmten Benutzers und die Aktivitäten der von ihm "verfolgten Kontakte" abgerufen werden. Social Network API-D
Webservice Nachrichten public 1.3.6.1.4.1.37553.8.1.8.3.8.10.1
Beispiel-Code
Mit einem JavaScript Code können die neuesten Nachrichten verschiedener Anbieter auf der eigenen Internetseite angezeigt und verlinkt werden. Webservice News API-D
Webfan Stream Syndication (wss) public 1.3.6.1.4.1.37553.8.1.8.3.8.15
http://www.webfan.de/webfanstreamsyndication.html
Mit Webfan Stream Syndication verpasst Du keine Neuigkeiten mehr und bleibst stehts auf dem Laufenden darüber was auf der Webfan Internetseite momentan geschieht. Webfan Stream Syndication (wss) API-D

 

API-A / API-B

Service/Funktion Teilnahme Info & Doku Beschreibung FLAG/Dienstkategorie API
Kleinanzeigenmarkt Netzwerk http://www.webfan.de/API.html http://www.webfan.de/Content-pid-Referenz-9.html Das Kleinanzeigennetzwerk ermöglicht den Austausch von Kleinanzeigen zwischen Kleinanzeigenmärkten. Dem Endbenutzer wird so die größere Verbreitung seiner Kleinanzeigen ohne Mehraufwand ermöglicht.
Es ist erwünscht das die Teilnehmer sowohl Kleinanzeigen senden als auch empfangen und veröffentlichen, eine einseitige Ausnutzung des Netzwerkes ist nicht zulässig.
Webmaster, Portal, Promotion, Sonstiges Api-A
Kleinanzeigen senden s.o. http://www.webfan.de/Content-pid-Referenz-9.html Ein Kleinanzeigenmarktbetreiber kann Annoncen über das Netzwerk an alle teilnehmenden Kleinanzeigenmärkte weiterverteilen. Webmaster, Portal, Promotion, Sonstiges Api-A
Kleinanzeigen empfangen s.o. http://www.webfan.de/Content-pid-Referenz-9.html Ein Kleinanzeigenmarktbetreiber kann eine Url zu einem Callback Script angeben an das automatisch die neuen Kleinanzeigen aus dem Netzwerk versendet werden. Webmaster, Portal, Promotion, Sonstiges Api-A
Kleinanzeige löschen s.o. http://www.webfan.de/Content-pid-Referenz-9.html Ein Kleinanzeigenmarktbetreiber kann eine Kleinanzeige die von seinem API Account inseriert wurde wieder löschen lassen. Der Löschen Request wird an alle teilnehmenden Kleinanzeigenmärkte des Netzwerkes gesendet. Webmaster, Portal, Promotion, Sonstiges Api-A
Teilnehmerliste abrufen public http://www.webfan.de/Content-pid-Teilnehmer-Live-Liste-public-function--13.html Die Funktion zeigt eine Liste der Kleinanzeigenmärkte an welche am Netzwerk teilnehmen. Webmaster, Portal, Promotion, Sonstiges Api-A
Webkatalog Netzwerk http://www.webfan.de/API.html http://www.webfan.de/Content-cid-API-Dokumentation-9.html Das Webkatalognetzwerk ermöglicht den Austausch von Linkeinträgen zwischen Webkatalogen. Dem Endbenutzer wird so die größere Verbreitung seiner Linkeinträge ohne Mehraufwand ermöglicht.
Es ist erwünscht das die Teilnehmer sowohl Weblinks senden als auch empfangen und veröffentlichen, eine einseitige Ausnutzung des Netzwerkes ist nicht zulässig.
Webmaster, Portal, Promotion, Sonstiges Api-A
Weblinks senden s.o. http://www.webfan.de/Content-pid-Referenz-10.html Ein Webkatalogbetreiber kann Linkeinträge über das Netzwerk an alle teilnehmenden Webkataloge weiterverteilen. Webmaster, Portal, Promotion, Sonstiges Api-A
Linkeinträge empfangen s.o. http://www.webfan.de/Content-pid-Referenz-10.html Ein Webkatalogbetreiber kann eine Url zu einem Callback Script angeben an das automatisch die neuen Linkeinträge aus dem Netzwerk versendet werden. Webmaster, Portal, Promotion, Sonstiges Api-A
Teilnehmerliste abrufen public http://www.webfan.de/Content-pid-Teilnehmerliste-Webkataloge-public-function--19.html Die Funktion zeigt eine Liste der Webkataloge an welche am Netzwerk teilnehmen. Webmaster, Portal, Promotion, Sonstiges Api-A
API Statistik (von API-A) abrufen public http://www.webfan.de/Content-pid-API-Statistik-public-function--16.html
http://www.webfan.de/Content-pid-Public-functions-14.html
Die Funktion zeigt eine Zugriffs- und API- Statistik von API-A an. Metainformationen Api-A
Search API Nur exklusiv für Webfan Linkpartner!
Individuelle Kontaktaufnahme: http://www.webfan.de/Feedback.html
http://www.webfan.de/Forum-topic-232-start-msg613.html#msg613
Demo:
http://www.homepagespeicher.de/sitesearch.php?q=php
Eine kleine exklusive Auswahl an Linkpartnerseiten wird vom Webfan Web Crawler gespidert und erscheint in der Webfan Suche. Web Api-A
Whois API - deprecated - wird zunächst nicht weiterentwickelt http://www.webfan.de/News-sid-Whois-Domainabfrage-Service-API-Script-447.html Mit diesem API Script kannst Du whois-Abfragen durchführen. Web Api-
BIZ API http://domainundhomepagespeicher.webfan.de/shop/onlineshop-mit-asp-und-biz-api-account.39.html http://tillwehowski.webfan.de/biz-api-+-asp-dokumentation.kat-39.html Das BIZ API bedient derzeit die Onlineshops des Webfan Homepagesystems und wird in naher Zukunft durch neue Funktionen und Techniken erweitert. Das Homepagesystem ermöglicht das einfache Betreiben eines umfangreichen Onlineshops mit komplexen Verwaltungs- und Exportfunktionen. Unter anderem bietet das System ein automatisches Vertragswesen und biete eine automatische Rechnungserstellung samt E-Mail Versand und Mahnwesen. Das BIZ API ermöglicht das Vernetzen des Shopsystems mit beliebiger Drittsoftware. Bestellungen und Bezahlungen/Freischaltaktionen  beispielsweise können an ein Web-Callback-Script automatisch übermittelt werden, über "benutzerdefinierte Formularfelder" kann der Shopbetreiber dabei die für ihn wichtigen Kundendaten erheben.
http://tillwehowski.webfan.de/biz-api-+-asp-dokumentation.kat-39.html
E-Commerce API-B
Bestellung melden s.o. http://tillwehowski.webfan.de/biz-api-handles.107.html Der Shopbetreiber kann ein Web-Script angeben an das neue Bestellungen gepostet werden. E-Commerce API-B
Leistungsaktivierung melden s.o. http://tillwehowski.webfan.de/leistungsaktivierung-biz-api--handle.112.html Der Shopbetreiber kann für jedes Produkt individuell auswählen ob er eine Leistung automatisch nach der Bestellung, automatisch nach der Bezahlung oder manuell freischalten möchte. Das BIZ API meldet sich beim durch den Shopbetreiber vorgegebenen Web-Script wenn die Leistung eines Rechnungspostens freigeschaltet/aktivert werden soll. Die geschäftlichen Vorgänge im Shop können so automatisch mit der Produktionsschicht des Shopbetreibers koordiniert werden, oder umgekehrt;-) E-Commerce API-B
Revalidierungsrequest s.o. http://tillwehowski.webfan.de/bizapirevalidierungsrequest.108.html Jedes API-"Handle" hat individuelle Checksummenbildungsregeln. Jeder API-Request kann durch einen "Revalidierungsrequest" überprüft werden. Neben Passwörtern können authorisierte IPs und Hosts angegeben werden. E-Commerce API-B
Gebuehreneinheit-Abrechnung s.o. http://tillwehowski.webfan.de/biz-api-handles.107.html Neben einem "Gutscheinkonto" bietet jedes Kundenkonto des Shopsystems über zwei "Gebührenkonten". Über jedes dieser Konten können beliebig viele verschiedene Leistungsvorgänge abgerechnet werden. Die Kontoführung erfolgt mit vier Stellen hinter dem Komma es kann eine monatliche Abrechnung und in Rechnungsstellung erfolgen. Der Kunde kann durch den Kauf spezieller Produkte seine Konten "aufladen", eine spätere Auszahlung des eingezahlten Guthabens ist nicht vorgesehen, es steht dem Shopbetreiber aber natürlich frei Gutschriften zu erstellen.
Über die API Schnittstelle kann die Produktionsschicht des Shopbetreibers beliebige Leistungsvorgänge automatisch über eines der Gebührenkonten abrechnen lassen.
E-Commerce API-B