Grundstruktur und Aufbau der URL

Last modified: 5. Mai 2022

API-Struktur

Der Aufruf der API geschieht über eine wohldefinierte URL. Wird von einem Aufruf eine XML-Datei geliefert, kann diese beispielsweise auch in einem Browserfenster eingegeben werden. Das resultierende XML wird dann vom Browser angezeigt.

Die URL besteht aus:

<Protokoll>://<Host>/<Version>/<Methode>/<Datenformat>.<Ausgabeformat>?<Parameter>

  1. API-Basis URL: ‚https://api.itscope.com
  2. Version: aktuelle Version ist die ‚/2.1
  3. Methode: beginnt zum Beispiel mit ‚/products‘. Eine Methode ist zum Beispiel ‚/search‘, gefolgt von den Filtern, beschrieben in URL-Pfad Syntax
  4. Datenformat: z.B. standard oder developer, beschrieben in Datenformaten
  5. Ausgabeformat: Ausgabeformate können csv, xml oder json sein.
  6. Parameter: abgetrennt vom Path durch ‚?‘ werden zusätzliche Angaben, zum Beispiel zur Sortierung gemacht; diese werden in URL-Parameter Syntax beschrieben

Durch zusammesetzen dieser Elemente ergibt sich daraus der Link zu einem API Abruf z.B.

https://api.itscope.com/2.1/products/search/keywords=server%20barebone/standard.xml?sort=DEFAULT

Was this article helpful?
Dislike 0
Views: 394