Integration API Documentation

Softvision Agenda provides a REST API system that allows other applications to connect to it to retrieve data, create reservations, etc.

Technologies used

The APIs use the REST model with token-based authentication. Data exchange with the exposed services is done using JSON format.

Data format

• Currency: the symbol "." is used for decimals. Valid examples: 10.5, 0.5, 35.0, 35
• Date and time: APIs use ISO 8601 format.
  Examples:
  2020-07-27T18:51:45
  2019-07-17T10:51:14.2321

Registering your application

To use the services, the developer must request a code called "TenancyName" via email to info@softvision.it with the following details:

• Full name / company name
• Login used to access the Agenda application

Usage examples

A C# project with API call examples is available. Refer to it for details of the data structures used by the APIs (CustomerDto, ServiceDto, ResourceDto, etc.).

Click here to download the project

Using the APIs

Your application must first obtain a Token (alphanumeric string) from our server. This Token, valid for 24 hours, must be included in all API calls in the Authorization header as "Bearer +token".
Example: if the token is "a35gdfdf453gfsd32", the header should be "Bearer a35gdfdf453gfsd32". Responses are structured as follows:

Error: error description
UnAuthorizedRequest:boolean
Result: API call result in JSON format

Available API endpoints

Authentication

• ENDPOINT: https://agapi.softvision.it/api/TokenAuth/Authenticate
• Method: POST
• Parameters: userNameOrEmailAddress:string
  Password:string
  TenancyName:string
• Response: AccessToken:string
  ExpireInSeconds:number
  UserId:number
  AccountExpired:boolean

Get customer list

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/getall
• Method: POST
• Parameters: skipCount:number
  maxResultCount:number
• Response: totalCount:number
  items: list of customers (CustomerDto structure)

Get single customer

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Method: GET
• Parameters: IDCLIENTE:number
• Response: CustomerDto structure

Delete customer

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Method: DELETE
• Parameters: IDCLIENTE:number
• Response: no data

Update customer

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Method: PUT
• Parameters: IDCLIENTE:number (url)
  CustomerDto structure (message body)
• Response: CustomerDto structure

Create customer

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers
• Method: POST
• Parameters: CustomerDto structure (message body)
• Response: CustomerDto structure

Resources, Services, Staff, and Locations

Calls for these elements are structurally identical to the above. Endpoints are:

• Resources: https://agapi.softvision.it/api/services/app/resources (ResourceDto structure)
• Services: https://agapi.softvision.it/api/services/app/services (ServiceDto structure)
• Staff: https://agapi.softvision.it/api/services/app/staffmembers (StaffmemberDto structure)
• Locations: https://agapi.softvision.it/api/services/app/locations (LocationDto structure)

Get appointments list

• ENDPOINT: https://agapi.softvision.it/api/services/app/Reservations/GetReport
• Method: POST
• Parameters: skipCount:number
  maxResultCount:number
  start:date
  end:date
  locationId:number (required)
  resourceId:number (optional)
  staffMemberId:number (optional)
• Response: totalCount:number
  items: list of appointments (ReportReservationDto structure)