Integrations-API-Dokumentation

Softvision Agenda bietet ein REST-API-System, das anderen Anwendungen den Zugriff auf Daten, das Erstellen von Reservierungen usw. ermöglicht.

Verwendete Technologien

Die APIs verwenden das REST-Modell mit tokenbasierter Authentifizierung. Der Datenaustausch erfolgt im JSON-Format.

Datenformat

• Währung: Das Symbol "." wird für Dezimalstellen verwendet. Gültige Beispiele: 10.5, 0.5, 35.0, 35
• Datum und Uhrzeit: APIs verwenden das ISO-8601-Format.
  Beispiele:
  2020-07-27T18:51:45
  2019-07-17T10:51:14.2321

Anwendung registrieren

Um die Dienste zu nutzen, muss der Entwickler einen Code namens "TenancyName" per E-Mail an info@softvision.it anfordern mit:

• Vollständiger Name / Firmenname
• Login, der für den Zugriff auf die Agenda-Anwendung verwendet wird

Beispiele

Ein C#-Projekt mit API-Beispielen ist verfügbar. Verwenden Sie es für Details zu den verwendeten Datenstrukturen (CustomerDto, ServiceDto, ResourceDto usw.).

Klicken Sie hier, um das Projekt herunterzuladen

Verwendung der APIs

Ihre Anwendung muss zuerst ein Token (alphanumerische Zeichenfolge) von unserem Server abrufen. Dieses Token, gültig für 24 Stunden, muss in allen API-Aufrufen im Authorization-Header als "Bearer +token" enthalten sein.
Beispiel: Wenn das Token "a35gdfdf453gfsd32" lautet, lautet der Header "Bearer a35gdfdf453gfsd32". Antworten sind wie folgt strukturiert:

Error: Fehlerbeschreibung
UnAuthorizedRequest:boolean
Result: Ergebnis des API-Aufrufs im JSON-Format

Verfügbare Endpoints

Authentifizierung

• ENDPOINT: https://agapi.softvision.it/api/TokenAuth/Authenticate
• Methode: POST
• Parameter: userNameOrEmailAddress:string
  Password:string
  TenancyName:string
• Antwort: AccessToken:string
  ExpireInSeconds:number
  UserId:number
  AccountExpired:boolean

Kundenliste abrufen

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/getall
• Methode: POST
• Parameter: skipCount:number
  maxResultCount:number
• Antwort: totalCount:number
  items: Liste von Kunden (CustomerDto)

Einzelkunden abrufen

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Methode: GET
• Parameter: IDCLIENTE:number
• Antwort: CustomerDto

Kunde löschen

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Methode: DELETE
• Parameter: IDCLIENTE:number
• Antwort: keine Daten

Kunde aktualisieren

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Methode: PUT
• Parameter: IDCLIENTE:number (url)
  CustomerDto (Body)
• Antwort: CustomerDto

Kunde erstellen

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers
• Methode: POST
• Parameter: CustomerDto (Body)
• Antwort: CustomerDto

Ressourcen, Services, Personal und Standorte

Diese Aufrufe sind strukturell identisch zu den vorherigen. Endpoints:

• Ressourcen: https://agapi.softvision.it/api/services/app/resources (ResourceDto)
• Services: https://agapi.softvision.it/api/services/app/services (ServiceDto)
• Personal: https://agapi.softvision.it/api/services/app/staffmembers (StaffmemberDto)
• Standorte: https://agapi.softvision.it/api/services/app/locations (LocationDto)

Terminliste abrufen

• ENDPOINT: https://agapi.softvision.it/api/services/app/Reservations/GetReport
• Methode: POST
• Parameter: skipCount:number
  maxResultCount:number
  start:date
  end:date
  locationId:number (erforderlich)
  resourceId:number (optional)
  staffMemberId:number (optional)
• Antwort: totalCount:number
  items: Liste von Terminen (ReportReservationDto)