Documentation de l'API d'intégration

Softvision Agenda fournit un système d'API REST qui permet à d'autres applications de se connecter pour obtenir des données, créer des réservations, etc.

Technologies utilisées

Les API utilisent le modèle REST avec une authentification par token. L'échange de données avec les services exposés se fait au format JSON.

Format des données

• Monnaie : le symbole "." est utilisé pour les décimales. Exemples valides : 10.5, 0.5, 35.0, 35
• Date et heure : les API utilisent le format ISO 8601.
  Exemples :
  2020-07-27T18:51:45
  2019-07-17T10:51:14.2321

Enregistrement de l'application

Pour utiliser les services, le développeur doit demander un code appelé "TenancyName" par email à info@softvision.it avec les informations suivantes :

• Nom complet / société
• Login utilisé pour accéder à l'application Agenda

Exemples d'utilisation

Un projet C# contenant des exemples d'appels API est disponible. Référez-vous à ce projet pour les détails des structures de données utilisées (CustomerDto, ServiceDto, ResourceDto, etc.).

Cliquez ici pour télécharger le projet

Utilisation des APIs

Votre application doit d'abord obtenir un Token (chaîne alphanumérique) depuis notre serveur. Ce Token, valide 24 heures, doit être inclus dans toutes les requêtes API dans l'en-tête Authorization comme "Bearer +token".
Exemple : si le token est "a35gdfdf453gfsd32", l'en-tête sera "Bearer a35gdfdf453gfsd32". Les réponses suivent la structure suivante :

Error : description de l'erreur
UnAuthorizedRequest : boolean
Result : résultat de l'appel en format JSON

Endpoints disponibles

Authentification

• ENDPOINT : https://agapi.softvision.it/api/TokenAuth/Authenticate
• Méthode : POST
• Paramètres : userNameOrEmailAddress:string
  Password:string
  TenancyName:string
• Réponse : AccessToken:string
  ExpireInSeconds:number
  UserId:number
  AccountExpired:boolean

Liste des clients

• ENDPOINT : https://agapi.softvision.it/api/services/app/customers/getall
• Méthode : POST
• Paramètres : skipCount:number
  maxResultCount:number
• Réponse : totalCount:number
  items : liste de clients (CustomerDto)

Client unique

• ENDPOINT : https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Méthode : GET
• Paramètres : IDCLIENTE:number
• Réponse : CustomerDto

Supprimer un client

• ENDPOINT : https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Méthode : DELETE
• Paramètres : IDCLIENTE:number
• Réponse : aucune donnée

Modifier un client

• ENDPOINT : https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Méthode : PUT
• Paramètres : IDCLIENTE:number (url)
  CustomerDto (corps de la requête)
• Réponse : CustomerDto

Créer un client

• ENDPOINT : https://agapi.softvision.it/api/services/app/customers
• Méthode : POST
• Paramètres : CustomerDto (corps de la requête)
• Réponse : CustomerDto

Ressources, Services, Personnel et Lieux

Ces appels sont structurellement identiques aux précédents. Endpoints :

• Ressources : https://agapi.softvision.it/api/services/app/resources (ResourceDto)
• Services : https://agapi.softvision.it/api/services/app/services (ServiceDto)
• Personnel : https://agapi.softvision.it/api/services/app/staffmembers (StaffmemberDto)
• Lieux : https://agapi.softvision.it/api/services/app/locations (LocationDto)

Liste des rendez-vous

• ENDPOINT : https://agapi.softvision.it/api/services/app/Reservations/GetReport
• Méthode : POST
• Paramètres : skipCount:number
  maxResultCount:number
  start:date
  end:date
  locationId:number (obligatoire)
  resourceId:number (optionnel)
  staffMemberId:number (optionnel)
• Réponse : totalCount:number
  items : liste de rendez-vous (ReportReservationDto)