vectorsoft Webservices

Die vectorsoft-Webservices stellen den Zugriff auf Kunden-spezifische Informationen, wie beispielsweise Lizenzinformationen bereit. Die Dienste können mit einem HTTP-Client unter der Adresse https://services.vectorsoft.de konsumiert werden. Die Daten werden im JSON-Format übertragen.

Funktionen

Die Funktionsaufrufe sind nach dem folgenden Muster dokumentiert:

<Methode> <Ressource>

<Methode> beschreibt die zu verwendende HTTP-Methode.
<Ressource> beschreibt die anzufordernde Ressource.

Innerhalb der Ressource enthaltene Platzhalter ({...}) müssen durch entsprechende Werte ersetzt werden.

Konnte die Funktion erfolgreich durchgeführt werden, liefert der Dienst den HTTP-Statuswert 200, sonst den Wert 400 und einen Fehler nach dem folgenden Muster:

Folgende Funktionen können aufgerufen werden:

• login – Anmelden
  
  Anfrage
  
  
  PUT /2/login
  

  { "username" : "{username}", "password" : "{password}" }

  
  

  {username} – Benutzername
  {password} – Passwort
  
  
  Antwort
  
  
  { "session" : { "id" : "0123abcdABCDwxyzWXYZ-_==", "timeout" : 120 } }

  
  Elemente
  
  

  "id" : string – Sitzungs-ID
  "timeout" : number – Sitzungsgültigkeit [Sekunden]
  
• logout – Abmelden
  
  Anfrage
  
  
  PUT /2/logout?sid={session-id}
  
  

  {session-id} – Sitzungs-ID
  
• c16/licenses – CONZEPT 16-Lizenzen ermitteln
  
  Anfrage
  
  
  GET /2/c16/licenses?sid={session-id}
  
  

  {session-id} – Sitzungs-ID
  
  
  Antwort
  
  
  { "123456" : { "id" : 123456, "name" : "CE123456MN", "userLimit" : 20, "userCounting" : "W", "version" : "5.7.00", "expiration" : "2013-10-01", "protection" : "N", "service" : { "active" : true "expiration" : "2013-07-01", "renewal" : true }, "communication" : { "lastContact" : "2013-01-01T13:15:30Z", "platform" : { "serverVersion" : "5.7.01", "os" : "Windows Server 2008 R2 (64-Bit)", "ramMb" : 8192, "cpuCount" : 4 }, "executability-criteria" : { "expiration" : "2013-01-09T13:15:30Z", "reputation" : { "license" : 60.0, "host" : 60.0 } } }, "executability-level" : "assured", "customer" : "Mustermann AG", "customerOnInvoice" : true, "notes" : "Administrator: Hr. Mustermann", "options" : 5, "cancelled" : "", "earliestSvcExp" : "2019-10-13" }, ... }

  
  Elemente
  
  

  "id" : number – Lizenznummer
  "name" : string – Lizenzschlüssel
  "userLimit" : number – Benutzerlimit, falls vorhanden
  "userCounting" : string – Benutzerzählung ("W" : Workstation = pro Arbeitsstation, "C" : Connection = pro Verbindung)
  "version" : string – Version, falls vorhanden
  "expiration" : string – Ablauf (Datum nach ISO 8601), falls vorhanden
  "protection" : string – Schutz ("U" : USB-Dongle, "P" : Parallel-Dongle, "N" : Internet), falls vorhanden
  "service" : object – Softwarepflege, falls vorhanden
  "active" : boolean – Aktiv
  "expiration" : string – Ablauf (Datum nach ISO 8601)
  "renewal" : boolean – automatische Verlängerung
  "communication" : object – Kommunikation mit Lizenzserver, falls vorhanden
  "lastContact" : string – letzter Kontakt (Datum und Zeit nach ISO 8601)
  "platform" : object – Plattform
  "serverVersion" : string – Serverversion
  "os" : string – Betriebssystem
  "ramMb" : number – Hauptspeicher [MB]
  "cpuCount" : number – logische Prozessoren
  "executability-criteria" : object – Lauffähigkeitskritieren (nur bei Internet-Schutz)
  "expiration" : string – Gültigkeit (Datum und Zeit nach ISO 8601)
  "reputation" : object – Bewertung
  "license" : number – Lizenz
  "host" : number – Host
  "executability-level" : string – Lauffähigkeit (nur bei Internet-Schutz; "assured" : gesichert, "threatened" : gefährdet, "restricted" : eingeschränkt, "inactive" : inaktiv, "needserver" : Verbindung zu Lizenzservern benötigt)
  "customer" : string – Kunde
  "customerOnInvoice" : boolean – Kunde auf Rechnung
  "notes" : string – Bemerkung
  "options" : number – Lizenzoptionen (0x01 : Kunde auf Rechnung drucken, 0x02 : Benutzerzählung pro Datenbankverbindung, 0x04 : Datensatzverwaltung gesperrt)
  "cancelled" : string – Gekündigt zum
  "earliestSvcExp" : string – Kündbar zum
  
• c16/licenses/{license-id} – CONZEPT 16-Lizenz ermitteln
  
  Anfrage
  
  
  GET /2/c16/licenses/{license-id}?sid={session-id}
  
  

  {license-id} – Lizenznummer
  {session-id} – Sitzungs-ID
  
  
  Antwort
  
  
  { "id" : 123456, "name" : "CE123456MN", "userLimit" : 20, "userCounting" : "W", "version" : "5.7.00", "expiration" : "2013-10-01", "protection" : "N", "service" : { "active" : true "expiration" : "2013-07-01", "renewal" : true }, "communication" : { "lastContact" : "2013-01-01T13:15:30Z", "platform" : { "serverVersion" : "5.7.01", "os" : "Windows Server 2008 R2 (64-Bit)", "ramMb" : 8192, "cpuCount" : 4 }, "executability-criteria" : { "expiration" : "2013-01-09T13:15:30Z", "reputation" : { "license" : 60.0, "host" : 60.0 } } }, "executability-level" : "assured", "customer" : "Mustermann AG", "customerOnInvoice" : true, "notes" : "Administrator: Hr. Mustermann", "options" : 5, "cancelled" : "", "earliestSvcExp" : "2019-10-13" }

  
  Elemente
  
  

  Siehe c16/licenses – CONZEPT 16-Lizenzen ermitteln
  
• c16/licenses/{license-id} – CONZEPT 16-Lizenzinformationen setzen
  
  Anfrage
  
  
  PUT /2/c16/licenses/{license-id}?sid={session-id}
  

  { "customer" : "{customer}", "notes" : "{notes}", "options" : {options} }

  
  

  {license-id} – Lizenznummer
  {session-id} – Sitzungs-ID
  {customer} – Kunde (z. B. Name oder interne ID)
  {notes} – Bemerkung
  {options} – Lizenzoptionen (0x01 : Kunde auf Rechnung drucken, 0x02 : Benutzerzählung pro Datenbankverbindung, 0x04 : Datensatzverwaltung gesperrt)
  
  
  Antwort
  
  
  { "result" : 0, "message" : "License informations sucessfully set." }

  
  Elemente
  
  

  "result" : number – Resultat (0 : Lizenzdaten erfolgreich gespeichert, 0x10000001 : Die Lizenz ist nicht vorhanden, 0x10000002 : Die Lizenz ist gesperrt)
  "message" : string – Erläuterung zu "result"
  
• c16/tickets – CONZEPT 16-Supporttickets ermitteln
  
  Anfrage
  
  
  GET /2/c16/tickets?sid={session-id}
  
  

  {session-id} – Sitzungs-ID
  
  
  Antwort
  
  
  { "tickets" : [{ "number" : "NF0815DE", "date" : "2018-06-12T09:30:00Z", "title" : "Frage zur Dokumentation", "state" : 33 }, ... ] }

  
  Elemente
  
  

  "number" : string – Ticketnummer
  "date" : number – Ticketeröffnung (Datum und Zeit nach ISO 8601)
  "title" : string – Titel des Tickets
  "state" : number – Ticketstatus (11 : warten auf Kunde, 21 : in Bearbeitung, 22 : zurückgestellt, 23 : Fehler aufgenommen, 24 : Vorschlag aufgenommen, 31 : Fehler behoben, 32 : Vorschlag realisiert, 33 : abgeschlossen, 41 : Fehler ohne Behebung, 42 : Vorschlag nicht realsisierbar)
  
• c16/licenses/{license-id}/invoices – Softwarepflegerechnungen für CONZEPT 16-Lizenz ermitteln
  
  Anfrage
  
  
  GET /2/c16/licenses/{license-id}/invoices?sid={session-id}
  
  

  {license-id} – Lizenznummer
  {session-id} – Sitzungs-ID
  
  
  Antwort
  
  
  { "11309-12345" : { "number" : "11309-12345", "orderNumber" : 123456, "date" : "2013-09-01", "currency" : "EUR", "serviceItem" : { "serviceBegin" : "2013-10-01", "serviceEnd" : "2013-12-31", "price" : "100.00" } }, ... }

  
  Elemente
  
  

  "number" : string – Rechnungsnummer
  "orderNumber" : number – Auftragsnummer
  "date" : string – Rechnungsdatum (nach ISO 8601)
  "currency" : string – Währung (Code nach ISO 4217; "EUR" : Euro, "CHF" : Schweizer Franken)
  "serviceItem" : object – Rechnungsposition für Softwarepflege
  "serviceBegin" : string – Anfang des in Rechnung gestellten Softwarepflegezeitraums (Datum nach ISO 8601)
  "serviceEnd" : string – Ende des in Rechnung gestellten Softwarepflegezeitraums (Datum nach ISO 8601)
  "price" : string – Preis (Kommazahl mit "." als Dezimaltrennzeichen und zwei Nachkommastellen)
  
• invoices/{invoice-no} – Rechnung ermitteln
  
  Anfrage
  
  
  GET /2/invoices/{invoice-no}?sid={session-id}
  
  

  {invoice-no} – Rechnungsnnummer
  {session-id} – Sitzungs-ID
  
  
  Antwort
  
  
  { "number" : "11309-12345", "orderNumber" : 123456, "date" : "2013-09-01", "amount" : "1000.00", "amountGross" : "1190.00", "currency" : "EUR", "c16ServiceItems" : [{ "licenseNo" : 123456, "serviceBegin" : "2013-10-01", "serviceEnd" : "2013-12-31", "price" : "100.00" }, ... ] }

  
  Elemente
  
  

  "number" : string – Rechnungsnummer
  "orderNumber" : number – Auftragsnummer
  "date" : string – Rechnungsdatum (nach ISO 8601)
  "amount" : string – Rechnungsbetrag (Kommazahl mit "." als Dezimaltrennzeichen und zwei Nachkommastellen)
  "amountGross" : string – Bruttorechnungsbetrag (Kommazahl mit "." als Dezimaltrennzeichen und zwei Nachkommastellen)
  "currency" : string – Währung (Code nach ISO 4217; "EUR" : Euro, "CHF" : Schweizer Franken)
  "c16ServiceItems" : array – Rechnungspositionen für Softwarepflege für CONZEPT 16-Lizenzen, falls vorhanden
  "licenseNo" : number – Lizenznummer
  "serviceBegin" : string – Anfang des in Rechnung gestellten Softwarepflegezeitraums (Datum nach ISO 8601)
  "serviceEnd" : string – Ende des in Rechnung gestellten Softwarepflegezeitraums (Datum nach ISO 8601)
  "price" : string – Preis (Kommazahl mit "." als Dezimaltrennzeichen und zwei Nachkommastellen)