Documentação da API de integração

O Softvision Agenda fornece um sistema de API REST que permite que outros aplicativos se conectem para obter dados, criar reservas, etc.

Tecnologias utilizadas

As APIs usam o modelo REST com autenticação baseada em token. A troca de dados com os serviços expostos é feita no formato JSON.

Formato dos dados

• Moeda: o símbolo "." é usado para decimais. Exemplos válidos: 10.5, 0.5, 35.0, 35
• Data e hora: as APIs usam o formato ISO 8601.
  Exemplos:
  2020-07-27T18:51:45
  2019-07-17T10:51:14.2321

Registro do aplicativo

Para usar os serviços, o desenvolvedor deve solicitar um código chamado "TenancyName" por e-mail para info@softvision.it com as seguintes informações:

• Nome completo / empresa
• Login usado para acessar o aplicativo Agenda

Exemplos de uso

Um projeto C# com exemplos de chamadas de API está disponível. Consulte-o para detalhes das estruturas de dados usadas (CustomerDto, ServiceDto, ResourceDto, etc.).

Clique aqui para baixar o projeto

Uso das APIs

Seu aplicativo deve primeiro obter um Token (string alfanumérica) do nosso servidor. Este Token, válido por 24 horas, deve ser incluído em todas as chamadas API no cabeçalho Authorization como "Bearer +token".
Exemplo: se o token for "a35gdfdf453gfsd32", o cabeçalho deve ser "Bearer a35gdfdf453gfsd32". As respostas seguem a seguinte estrutura:

Error: descrição do erro
UnAuthorizedRequest:boolean
Result: resultado da chamada em formato JSON

Endpoints disponíveis

Autenticação

• ENDPOINT: https://agapi.softvision.it/api/TokenAuth/Authenticate
• Método: POST
• Parâmetros: userNameOrEmailAddress:string
  Password:string
  TenancyName:string
• Resposta: 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
• Resposta: 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
• Resposta: CustomerDto

Excluir cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Método: DELETE
• Parâmetros: IDCLIENTE:number
• Resposta: nenhum dado

Atualizar cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers/IDCLIENTE
• Método: PUT
• Parâmetros: IDCLIENTE:number (url)
  CustomerDto (corpo da mensagem)
• Resposta: CustomerDto

Criar cliente

• ENDPOINT: https://agapi.softvision.it/api/services/app/customers
• Método: POST
• Parâmetros: CustomerDto (corpo da mensagem)
• Resposta: CustomerDto

Recursos, Serviços, Equipe e Localizações

As chamadas para esses elementos são estruturalmente idênticas às anteriores. Endpoints:

• Recursos: https://agapi.softvision.it/api/services/app/resources (ResourceDto)
• Serviços: https://agapi.softvision.it/api/services/app/services (ServiceDto)
• Equipe: https://agapi.softvision.it/api/services/app/staffmembers (StaffmemberDto)
• Localizações: https://agapi.softvision.it/api/services/app/locations (LocationDto)

Lista de compromissos

• 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 (obrigatório)
  resourceId:number (opcional)
  staffMemberId:number (opcional)
• Resposta: totalCount:number
  items: lista de compromissos (ReportReservationDto)