Documentación de la API de integración

Softvision Agenda proporciona un sistema de API REST que permite a otras aplicaciones conectarse para obtener datos, crear reservas, etc.

Tecnologías utilizadas

Las API utilizan el modelo REST con autenticación basada en token. El intercambio de datos con los servicios expuestos se realiza en formato JSON.

Formato de datos

• Moneda: se usa el símbolo "." para decimales. Ejemplos válidos: 10.5, 0.5, 35.0, 35
• Fecha y hora: las API usan el formato ISO 8601.
  Ejemplos:
  2020-07-27T18:51:45
  2019-07-17T10:51:14.2321

Registro de la aplicación

Para usar los servicios, el desarrollador debe solicitar un código llamado "TenancyName" por correo a info@softvision.it con los siguientes datos:

• Nombre completo / empresa
• Login usado para acceder a la aplicación Agenda

Ejemplos de uso

Hay disponible un proyecto en C# con ejemplos de llamadas a la API. Úselo para detalles de las estructuras de datos utilizadas (CustomerDto, ServiceDto, ResourceDto, etc.).

Haga clic aquí para descargar el proyecto

Uso de las APIs

Su aplicación debe obtener primero un Token (cadena alfanumérica) de nuestro servidor. Este Token, válido por 24 horas, debe incluirse en todas las llamadas API en el encabezado Authorization como "Bearer +token".
Ejemplo: si el token es "a35gdfdf453gfsd32", el encabezado será "Bearer a35gdfdf453gfsd32". Las respuestas tienen la siguiente estructura:

Error: descripción del error
UnAuthorizedRequest:boolean
Result: resultado de la llamada en formato JSON

Endpoints disponibles

Autenticación

• ENDPOINT: https://agapi.softvision.it/api/TokenAuth/Authenticate
• Método: POST
• Parámetros: userNameOrEmailAddress:string
  Password:string
  TenancyName:string
• Respuesta: AccessToken:string
  ExpireInSeconds:number
  UserId:number
  AccountExpired:boolean

Lista de clientes

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/getall
• Método: POST
• Parámetros: skipCount:number
  maxResultCount:number
• Respuesta: totalCount:number
  items: lista de clientes (CustomerDto)

Cliente único

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Método: GET
• Parámetros: IDCLIENTE:number
• Respuesta: CustomerDto

Eliminar cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Método: DELETE
• Parámetros: IDCLIENTE:number
• Respuesta: ningún dato

Actualizar cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Método: PUT
• Parámetros: IDCLIENTE:number (url)
  CustomerDto (body)
• Respuesta: CustomerDto

Crear cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers
• Método: POST
• Parámetros: CustomerDto (body)
• Respuesta: CustomerDto

Recursos, Servicios, Personal y Ubicaciones

Estas llamadas son estructuralmente idénticas a las anteriores. Endpoints:

• Recursos: https://agapi.softvision.it/api/services/app/resources (ResourceDto)
• Servicios: https://agapi.softvision.it/api/services/app/services (ServiceDto)
• Personal: https://agapi.softvision.it/api/services/app/staffmembers (StaffmemberDto)
• Ubicaciones: https://agapi.softvision.it/api/services/app/locations (LocationDto)

Lista de citas

• ENDPOINT: https://agapi.softvision.it/api/services/app/Reservations/GetReport
• Método: POST
• Parámetros: skipCount:number
  maxResultCount:number
  start:date
  end:date
  locationId:number (obligatorio)
  resourceId:number (opcional)
  staffMemberId:number (opcional)
• Respuesta: totalCount:number
  items: lista de citas (ReportReservationDto)