Eine API – was ist das?

Dieser Beitrag ist ebenfalls erhältlich in: Français

Während viele vielleicht wissen, dass «API» für «Application Programming Interface» oder auch Programmierschnittstelle steht, tappen die Meisten im Dunkeln, wenn es um eine einfache Erklärung geht wofür sie gebraucht wird.Eine API ist die Basis der Softwareentwicklung und ist seit dem Aufkommen des Web 2.0 auch vielen Nicht-Technikern ein Begriff geworden. Da auch smallinvoice über eine API verfügt, versuchen wir mit diesem Blogeintrag möglichst einfach zu erklären, was es damit auf sich hat.

Wofür braucht es eine API?

Eine API dient dem Austausch und der Verarbeitung von Daten zwischen verschiedenen Webseiten, Programmen und Anbietern. Sie ermöglicht es, Daten zwischen verschiedenen Anbietern und Lösungen zu teilen. Ein Beispiel hierfür ist z.B. der populäre «Facebook Login»: Dank der API von Facebook kann man sich auf einer Website, die «Facebook Login» verwendet, mit den Anmeldedaten von Facebook anmelden, ohne dass auf dieser Webseite ein Konto eröffnet werden muss. Dies funktioniert, weil der Betreiber der Website die Programmierschnittstelle von «Facebook» eingebunden hat und deren Funktion zur Authentifizierung von Benutzern verwendet.

Wie funktioniert eine API?

Zum einfacheren Verständnis muss an dieser Stelle ausgeholt und erklärt werden, wie Programme und Webseiten grundsätzlich funktionieren: Die visuelle Oberfläche («GUI» – Graphical User Interface oder auch «Frontend» genannt), dient als Schnittstelle zwischen Benutzer und der dahinter liegenden Softwarelogik, dem Backend. Das Frontend nimmt dabei Daten vom Benutzer entgegen, leitet diese zur Verarbeitung an das Backend weiter und gibt anschliessend das Resultat an den Benutzer via Frontend zurück. Oder anhand eines praktischen Beispiels erklärt: Ich gebe auf der Google-Webseite («Frontend») einen Suchbegriff ein, das Backend von Google sucht die Resultate und zeigt mir diese im Frontend an.

Die API ist im Grunde nichts anderes als ein Ersatz des für den Benutzer geschaffenen Frontends. An dessen Stelle tritt die API, die einen abstrahierten und strukturierten Zugriff auf die Funktionen des Backends ermöglicht. Oder einfach erklärt: Anstelle der Eingabe durch den Benutzer, werden mittels Programmierschnittstellen von einem Programm oder einer Webseite spezifische, für eine Software optimierte, Befehle an ein anderes Programm oder eine Webseite übermittelt. Damit das funktioniert, wird definiert, welche Befehle das Programm oder die Webseite übermitteln muss resp. darf, damit sie die gewünschten Resultate erhält; hierzu gibt es verschiedene Standards. Bei smallinvoice richten wir uns nach dem bei Webanwendungen verbreiteten «REST» Standard. Selbstverständlich gibt es Autorisierungsmethoden um Zugriffe zu kontrollieren und zu sichern. Eine gängige und sichere Methode, die bei der API 2.0 von smallinvoice, aber auch bei bekannten Anbietern wie «Facebook», «Twitter», «Google» und vielen anderen eingesetzt wird, ist «OAuth 2.0»

Welche Vorteile biete eine API bei smallinvoice?

Dank APIs kann smallinvoice mit diversen Programmen und Webseiten verbunden und somit die Funktionalität enorm erweitert werden. So kann smallinvoice beispielsweise über APIs mit verschiedenen Angeboten von «PostFinance», mit Anbietern wie «Payrexx» (Zahlungsdienstleister), «Mite» (Zeiterfassung), «Pingen» (Briefversand) und vielen mehr verbunden und genutzt werden. Auch der Zugang zum E-Salär Lohn-Modul geschieht mittels einer API.

Wer über Programmierkenntnisse verfügt, kann natürlich auch mittels der smallinvoice API eigene Programme oder Webdienste mit smallinvoice verbinden um z.B. Kontakte oder Rechnungsdaten auszutauschen bzw. durch smallinvoice verarbeiten zu lassen. Wie dies genau funktioniert, ist in unserer detaillierten smallinvoice API 2.0 Dokumentation unter folgendem Link erläutert.

Hast du ein Plugin oder ein Programm, das die API von smallinvoice verwendet, dann interessieren wir uns dafür: Melde dich doch bei unserem Support. Falls du ein Programm oder eine Webseite nutzt, die du gerne mit smallinvoice verbinden möchtest, dann kontaktiere doch deren Betreiber und weise diesen auf die Integrationsmöglichkeit mittels der smallinvoice API hin; besten Dank dafür!