{"id":11726,"date":"2022-06-14T08:19:21","date_gmt":"2022-06-14T05:19:21","guid":{"rendered":"https:\/\/www.fmsdocumentation.com\/apis\/"},"modified":"2022-06-14T08:19:21","modified_gmt":"2022-06-14T05:19:21","slug":"apis","status":"publish","type":"page","link":"https:\/\/www.fmsdocumentation.com\/de\/apis\/","title":{"rendered":"APIs"},"content":{"rendered":"<p>API (Application Programming Interface) erm\u00f6glicht es den Kunden, FMS mit ihrem System zu integrieren und Daten von verschiedenen Einheiten zu beziehen und an diese weiterzugeben.<\/p>\n<p>Der Kunde stellt HTTP-Anfragen an das System, die Informationen \u00fcber die beabsichtigte Aktion bieten. HTTP-Befehle die \u00fcblicherweise in einer API benutzt werden:<\/p>\n<ul>\n<li><strong>GET<\/strong> \u2013 Quelle lesen;<\/li>\n<li><strong>POST<\/strong>\u2013 Quellenstatus \u00e4ndern;<\/li>\n<\/ul>\n<p>Der angeforderte Inhalt wird im <strong>JSON<\/strong>-Format mit UTF-8-Kodierung bereitgestellt. Wenn ein anderes Format benutzt wird, wird dies in der Methodenbeschreibung festgelegt.<\/p>\n<p>Der HTTP-Statuscode erkennt den Status der Anfrage &#8211; f\u00fcr erfolgreiche Anfragen wird der Statuscode<strong>200<\/strong> ausgegeben. Zusammen mit dieser Antwort erh\u00e4lt man die vom Server angeforderten Informationen. Die Antworten werden sich je nach Art der verwendeten API unterscheiden. API-Antworten f\u00fcr unterschiedliche API-Typen werden in den entsprechenden Abschnitten beschrieben.<\/p>\n<p>Wenn ein Fehler hinsichtlich der gesendeten Anfrage auftritt, wird das System eine Antwortnachricht mit einem Statuscode zur\u00fccksenden. H\u00e4ufige Fehlercodes:<\/p>\n<ul>\n<li><strong>Code 400<\/strong> \u2013 Schlechte Anfrage \u2013 API-Anfrage wurde nicht erkannt.<\/li>\n<li><strong>Code 401<\/strong> \u2013 Nicht autorisiert \u2013 Dies bedeutet, dass die Authentifizierungsangaben fehlten oder falsch sind;<\/li>\n<li><strong>Code 403<\/strong> \u2013 Verboten \u2013 Dies bedeutet, dass der Kunde kein Recht hat, auf die angeforderte Quelle zuzugreifen oder die angeforderte Aktion durchzuf\u00fchren;<\/li>\n<li><strong>Code 404<\/strong> \u2013 Nicht gefunden \u2013 Dies bedeutet, dass die angeforderte Quelle nicht gefunden wurde.<\/li>\n<li><strong>Code 500<\/strong> \u2013 Interner Serverfehler \u2013 bitte setzen Sie sich mit Ihren Tech-Support-Anbietern in Verbindung.<\/li>\n<\/ul>\n<p>Fehlercodes bieten einige allgemeine Informationen \u00fcber die Art des Fehlers und erm\u00f6glichen es dem Benutzer so, die Ursache des Problems herauszufinden.<\/p>\n<p>Einige APIs verf\u00fcgen \u00fcber optionale Elemente (Parameter) in ihrer Antwort, optionale Parameter k\u00f6nnen vom System aus verschiedenen Gr\u00fcnden \u00fcbersprungen werden (keine Daten, schlechte Daten, Antwort-Timeout usw.). Ein Benutzer darf nicht annehmen, dass bestimmte optionale Daten immer in einer Antwort enthalten sein werden.<\/p>\n<hr>\n<h3>API-Beschr\u00e4nkungen<\/h3>\n<p>Alle APIs haben eine einzige Beschr\u00e4nkung:<\/p>\n<ul>\n<li>Nicht mehr als 1000 Anfragen pro Minute.<\/li>\n<\/ul>\n<p>Diese Beschr\u00e4nkung ist g\u00fcltig f\u00fcr alle in FMS bestehenden APIs.<\/p>\n<hr>\n<h3>API-Authentifizierung<\/h3>\n<p>Die API-Authentifizierung und -autorisierung sind erforderlich, um die API-Verwendung f\u00fcr verschiedene Kunden und ihre Integration mit verschiedenen Systemen zu steuern. Um eine autorisierte Anfrage an System-APIs vorzunehmen, muss die Kundenanfrage zuerst einen <strong>API_key<\/strong> im Namen des Webbenutzers erhalten.<\/p>\n<p>Kunden k\u00f6nnen einen API-Schl\u00fcssel nur durch direkte Kontaktaufnahme mit ihren Service-Anbietern f\u00fcr technischem Support erhalten. Der API-Schl\u00fcssel besteht aus zuf\u00e4llig erstellten Buchstaben, Zahlen und Symbolen.<\/p>\n<p>Beispiel f\u00fcr eine Anfrage unter Verwendung eines API_key:<\/p>\n<p><a href=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-589 size-full\" src=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/1.png\" alt=\"\" width=\"672\" height=\"92\" srcset=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/1.png 672w, https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/1-300x41.png 300w\" sizes=\"auto, (max-width: 672px) 100vw, 672px\" \/><\/a><\/p>\n<p>Wenn der API_key abgelaufen, entfernt oder einfach nur deaktiviert ist, wird das System die folgende Antworte geben:<\/p>\n<p><a href=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/2-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-590 size-full\" src=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/2-1.png\" alt=\"\" width=\"416\" height=\"72\" srcset=\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/2-1.png 416w, https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/2-1-300x52.png 300w\" sizes=\"auto, (max-width: 416px) 100vw, 416px\" \/><\/a><\/p>\n<p>API-Endpunkte, Anfrageparameter und Antworten k\u00f6nnen in \u201eSwagger\u201c \u00fcber den folgenden Ling vorab betrachtet werden: <a href=\"https:\/\/api.fm-track.com\/swagger-ui.html\">https:\/\/api.fm-track.com<\/a><\/p>\n<p style=\"background-color: #2e67b1; color: #ffffff; padding-left: 10px; padding-right: 10px;\"><p class=\"note\">Hinweis<br \/>\nEs ist immer erforderlich, eine API-Version in allen API-Arten festzulegen.<\/p><\/p>\n<p style=\"background-color: #2e67b1; color: #ffffff; padding-left: 10px; padding-right: 10px;\"><p class=\"note\">Wichtig!<br \/>\nAufgrund der st\u00e4ndigen Entwicklung der API und des Systems, von dem die Informationen angefordert werden, k\u00f6nnen Benutzer manchmal Parameter erhalten, die nicht in den Beschreibungen aufgef\u00fchrt sind. Es wird empfohlen, unbekannte Parameter, die nicht in jeder API-Beschreibung dokumentiert sind, zu ignorieren.<\/p><\/p>\n<hr>\n<h3>Versionierung und Kompatibilit\u00e4t<\/h3>\n<p>Die API-L\u00f6sung wird st\u00e4ndig aktualisiert, verbessert und anderweitig modifiziert. Daher ist es erforderlich, zu verstehen, was \u201eKompatibilit\u00e4t\u201c bedeutet und wie es, den Benutzer betrifft, wenn er die API-L\u00f6sung verwendet.<\/p>\n<p>Wenn eine API aktualisiert wird, kann eine der folgenden beiden Optionen auftreten:<\/p>\n<ul>\n<li>Die umgekehrt kompatible API \u2013 das bedeutet, dass die vorgenommenen Ver\u00e4nderungen, den Arbeitsablauf der API in keiner Weise beeinflussen werden, so dass keine neue Version erstellt wird.<\/li>\n<li>Die API ist nicht umgekehrt kompatibel \u2013 das bedeutet, dass einige API-Komponenten ge\u00e4ndert wurden, damit sie nicht mehr auf die gleiche Weise funktionieren wie zuvor. In diesem Fall, wird eine neue API-Version ver\u00f6ffentlicht.<\/li>\n<\/ul>\n<p>Was wird als eine umgekehrt kompatible API-Version angesehen:<\/p>\n<ul>\n<li>Neue API-Quellen wurden hinzugef\u00fcgt;<\/li>\n<li>Neue optionale Anfrageparameter wurden der bestehenden API hinzugef\u00fcgt<\/li>\n<li>Neue Eigenschaften wurden zu den vorhandenen API-Antworten hinzugef\u00fcgt.<\/li>\n<li>Die Reihenfolgen der Eigenschaften wurden in den bestehenden API-Antworten ge\u00e4ndert.<\/li>\n<li>Die Ver\u00e4nderung der L\u00e4nge oder des Formats der Objekt-IDs oder anderer undurchsichtigen Zeichenfolgen<br \/>\nDer Benutzer kann davon ausgehen, dass die vom System generierten Objekt-IDs nie l\u00e4nger als 255 Zeichen sind, aber er sollte in der Lage sein, IDs mit einer potenziellen L\u00e4nge von 255 Zeichen zu handhaben. Wenn der Benutzer beispielsweise MySQL verwendet, sollten die IDs in einer VARCHAR(255) COLLATE utf8_bin-Spalte gespeichert werden (die COLLATE-Konfiguration gew\u00e4hrleistet die Unterscheidung zwischen Gro\u00df- und Kleinschreibung bei Suchen)<\/li>\n<li>Hinzuf\u00fcgen neuer ENUM-Typen. \u2013 alle Systeme sollten unbekannte ENUM-Typen elegant behandeln. Wenn sich beispielsweise der Typ von [Privat, Gesch\u00e4ftlich] in [Privat, Arbeit, Gesch\u00e4ftlich] \u00e4ndert, sollte das keine Auswirkungen auf das System haben.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<hr>\n<p><div class=\"alignleft\"><a href=\"https:\/\/www.fmsdocumentation.com\/de\/fahrtenschreibermenue\/\" title=\"Fahrtenschreibermen\u00fc\"><span class=\"arrow\">\u2039 &nbsp <\/span> Fahrtenschreibermen\u00fc <\/a><\/div> <div class=\"alignright\"><a href=\"https:\/\/www.fmsdocumentation.com\/de\/fahrtzeitenmenue\/\" title=\"Fahrtzeitenmen\u00fc\">Fahrtzeitenmen\u00fc <span class=\"arrow\"> &nbsp\u203a <\/span> <\/a><\/div><\/p>\n","protected":false},"excerpt":{"rendered":"<p>API (Application Programming Interface) erm\u00f6glicht es den Kunden, FMS mit ihrem System zu integrieren und Daten von verschiedenen Einheiten zu beziehen und an diese weiterzugeben. Der Kunde stellt HTTP-Anfragen an das System, die Informationen \u00fcber die beabsichtigte Aktion bieten. HTTP-Befehle die \u00fcblicherweise in einer API benutzt werden: GET \u2013 Quelle lesen; POST\u2013 Quellenstatus \u00e4ndern; Der &hellip; <a href=\"https:\/\/www.fmsdocumentation.com\/de\/apis\/\" class=\"more-link\"><span class=\"screen-reader-text\">APIs<\/span> weiterlesen<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":116,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-11726","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/pages\/11726","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/comments?post=11726"}],"version-history":[{"count":0,"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/pages\/11726\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.fmsdocumentation.com\/de\/wp-json\/wp\/v2\/media?parent=11726"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}