Filazero API

Introdução

A API REST foi desenvolvida para permitir a integração entre sistemas de maineira fácil e segura. Através desta API será possível gerenciar todo o fluxo de atendimento e serviços disponibilidados para os clientes através da plataforma Filazero.

Location

API	Description
POST api/providers/{pid}/locations	No documentation available.
PUT api/providers/{pid}/locations/{locationId}	No documentation available.
DELETE api/providers/{pid}/locations/{locationId}	No documentation available.
GET api/providers/{pid}/locations	No documentation available.
GET api/providers/{pid}/locations/{locationId}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/holidays/{holidayId}	Retorna informações de um feriado
POST api/providers/{pid}/locations/{locationId}/holidays	Insere um novo feriado para uma unidade
PUT api/providers/{pid}/locations/{locationId}/holidays/{holidayId}	Atualiza informações de um feriado
DELETE api/providers/{pid}/locations/{locationId}/holidays/{holidayId}	Remove um feriado de uma unidade.
POST api/providers/{pid}/locations/{locationId}/feeds	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/feeds/{feedId}	No documentation available.
DELETE api/providers/{pid}/locations/{locationId}/feeds/{feedId}	No documentation available.
POST api/providers/{pid}/locations/{locationId}/associate-custom-fields	Associa filas a campos adicionais já existentes.
GET api/providers/{pid}/locations/{locationId}/custom-fields/{customFieldId}/options	No documentation available.
GET api/providers/{pid}/locations/{locationId}/custom-datas/{customFieldId}/customer/{customerId}	No documentation available.

ServiceManager

API	Description
GET api/providers/{pid}/locations/{locationId}/services	No documentation available.
GET api/providers/{pid}/locations/{locationId}/services/{serviceId}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/services/{serviceId}/serviceConfig/{serviceConfigId}	No documentation available.
POST api/providers/{pid}/locations/{locationId}/services	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/services/{serviceId}	No documentation available.
DELETE api/providers/{pid}/locations/{locationId}/services/{serviceId}	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/services/serviceConfig/{serviceConfigId}/prices	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/services/{serviceId}/estimatedPrice	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/services/serviceConfig/{serviceConfigId}/averageServiceDuration	No documentation available.

PublicService

API	Description
GET api/services/{serviceId}	No documentation available.

ServiceCategory

Categoria de serviço

API	Description
POST api/providers/{pid}/locations/{locationId}/serviceCategories	Criar uma nova categoria de serviço
PUT api/providers/{pid}/locations/{locationId}/serviceCategories/{serviceCategoryId}	Atualizar categoria de serviço
GET api/providers/{pid}/locations/{locationId}/serviceCategories	Obtém lista com todas as categorias de uma unidade
GET api/providers/{pid}/locations/{locationId}/serviceCategories/{serviceCategoryId}	Obtém uma categoria de serviço
DELETE api/providers/{pid}/locations/{locationId}/serviceCategories/{serviceCategoryId}	Remover uma categoria de serviço

Schedule

API	Description
GET api/providers/{pid}/services/{serviceId}/available-session-days?referenceMonth={referenceMonth}	Lista os dias que estão disponiveis (ou não) para o agendamento de um determinado serviço
GET api/providers/{pid}/locations/{locationId}/services/{serviceId}/sessions-resources-by-service?date={date}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/services/{serviceId}/next-available-session-day	A Proxima data disponivel
POST api/providers/{pid}/sessions/{sessionId}/tickets	Agenda atendimento

Payment

API	Description
GET api/providers/{pId}/locations/{locationId}/payments?status={status}&limit={limit}&offset={offset}	Obtem os pagamentos de uma unidade de negócio
GET api/providers/{pId}/locations/{locationId}/payments/{paymentId}	Obtem os pagamentos de uma unidade de negócio
POST api/providers/{pId}/locations/{locationId}/splitter	Cadastra um novo splitter
GET api/providers/{pId}/locations/{locationId}/splitter	Obtem um splitter de uma location
PUT api/providers/{pId}/locations/{locationId}/splitter	Atualizar um splitter
GET api/providers/{pId}/order-payments/{ticketId}	Obtem os pedidos de pagamento de um ticket
POST api/providers/{pId}/payment-operator	Efetuar pagamento via backoffice
GET api/providers/{pId}/locations/{locationId}/order-payments?status={status}&limit={limit}&offset={offset}	Obtem as ordens de uma unidade de negócio
GET api/providers/{pId}/locations/{locationId}/order-payments/{orderId}	Obtem a ordem por Id
POST api/providers/{pId}/locations/{locationId}/cancel-payment/{paymentId}	No documentation available.

SchedulingService

API	Description
GET api/v2/providers/{pid}/services	Retorna lista de serviços/especialidades que a empresa oferece.
GET api/v2/providers/{pid}/services/{serviceId}/business-units	Retorna lista de unidades de negócio que atendem o serviço especificado

Attendant

API	Description
POST api/providers/{pid}/locations/{locationId}/resources	No documentation available.
GET api/providers/{pid}/locations/{locationId}/resources?serviceIds[0]={serviceIds[0]}&serviceIds[1]={serviceIds[1]}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/resources/{resourceId}	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/resources/{resourceId}	No documentation available.
DELETE api/providers/{pid}/locations/{locationId}/resources/{resourceId}	No documentation available.

Session

API	Description
GET api/providers/{pid}/locations/{locationId}/sessions?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/sessions?date={date}	No documentation available.
POST api/providers/{pid}/locations/{locationId}/sessions	No documentation available.
GET api/providers/{pid}/locations/{locationId}/sessions/v2?date={date}&endDate={endDate}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/blockedSession/{sessionId}	Obtém as informações completas sobre uma sessão bloqueada.
PUT api/providers/{pid}/locations/{locationId}/blockedSession/{sessionId}?reason={reason}	Atualiza as informações de uma sessão bloqueada.
DELETE api/providers/{pid}/locations/{locationId}/sessions/{sessionId}?bulkUpdate={bulkUpdate}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/sessions/{sessionId}/delete-check	No documentation available.
GET api/providers/{pid}/locations/{locationId}/sessions/{sessionId}/update-check?weekdays[0]={weekdays[0]}&weekdays[1]={weekdays[1]}&period={period}&startDate={startDate}&endDate={endDate}&ocurrences={ocurrences}	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/sessions/{sessionId}	No documentation available.
GET api/providers/{pid}/sessions/{sessionId}/tickets-count	No documentation available.
GET api/providers/{pid}/sessions/{sessionId}/schedule-listing?limit={limit}&offset={offset}&orderBy={orderBy}	No documentation available.
GET api/providers/{pid}/sessions/{sessionId}	No documentation available.
POST api/providers/{pid}/locations/{locationId}/sessions/{sessionId}/lock?reason={reason}	No documentation available.
POST api/providers/{pid}/locations/{locationId}/sessions/{sessionId}/unlock	No documentation available.
GET api/providers/{pid}/sessions/{sessionId}/custom-fields	No documentation available.
GET api/providers/{pid}/sessions/{sessionId}/service/{serviceId}/payment-support	No documentation available.
GET api/providers/{pid}/get-price/service/{serviceId}/service-config/{configId}	Obter valor de um serviço

Ticketing

API	Description
GET api/providers/{pid}/tickets/search	No documentation available.
PATCH api/providers/{pid}/tickets/{customerServiceId}/metadata	Insere ou atualiza metadados do atendimento
GET api/providers/{pid}/tickets/{customerServiceId}/customdata	Retorna custom data de um atendimento
GET api/providers/{pid}/tickets/{customerServiceId}/orderpayment	Retorna order payment de um atendimento
GET api/providers/{pid}/tickets/{ticketId}/canceledticket	Retorna motivo de cancelamento de um ticket
POST api/providers/{pid}/tickets/{ticketId}/priority	Altera prioridade do atendimento
POST api/providers/{pid}/tickets/{ticketId}/cancel	Cancela o atendimento
POST api/providers/{pid}/tickets/{ticketId}/call	Chama cliente para atendimento
POST api/providers/{pid}/tickets/{ticketId}/reopen	Reabrir atendimento
POST api/providers/{pid}/session/{sessionId}/callnext	Chama próximo atendimento da sessão
POST api/providers/{pid}/sessions/{sessionId}/callnextpriority	Chama próximo atendimento prioritário
POST api/providers/{pid}/tickets/{ticketId}/start	Inicia atendimento
POST api/providers/{pid}/tickets/{ticketId}/complete	Finaliza atendimento
POST api/providers/{pid}/tickets/{ticketId}/check	Faz check-in
POST api/providers/{pid}/tickets/check-code	Faz check-in via terminal de autoatendimento
POST api/providers/{pid}/tickets/check-pit-code	Faz check-in no pit
POST api/providers/{pid}/tickets/{ticketId}/confirm	Confirmar atendimento
GET api/providers/{pid}/tickets/{ticketId}	Obtém detalhes do atendimento
GET api/providers/{pid}/locations/{locationId}/daily-tickets?date={date}&anyStatus={anyStatus}	Obtém lista de agendamentos para um determinado dia.
GET api/providers/{pid}/services/{serviceId}/daily-schedule?date={date}&orderBy={orderBy}&session={session}&serviceConfig={serviceConfig}&limit={limit}&offset={offset}&allServices={allServices}	Obtém lista de agendamentos para um determinado dia.
POST api/providers/{pid}/serviceConfigs/{serviceConfigId}/callnext	Chama próximo atendimento da sessão
GET api/providers/{pid}/locations/{locationid}/serviceConfigs/{serviceConfigId}/tickets-count?sessionId={sessionId}&ticketStatus={ticketStatus}&resourceId={resourceId}&attendanceType={attendanceType}	No documentation available.
GET api/providers/{pid}/locations/{locationid}/serviceConfigs/{serviceConfigId}/attendances?sessionId={sessionId}&ticketStatus={ticketStatus}&resourceId={resourceId}&attendanceType={attendanceType}	No documentation available.
GET api/providers/{pid}/locations/{locationid}/serviceConfigs/{serviceConfigId}/search-tickets?query={query}	No documentation available.
GET api/providers/{pid}/locations/{locationid}/serviceConfigs/{serviceConfigId}/attendances-duration?attendanceType={attendanceType}	No documentation available.

Room

API	Description
POST api/providers/{pid}/locations/{locationId}/rooms	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/rooms/{roomId}	No documentation available.
DELETE api/providers/{pid}/locations/{locationId}/rooms/{roomId}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/rooms	No documentation available.
GET api/providers/{pid}/locations/{locationId}/rooms/{roomId}	No documentation available.

ServiceConfig

API	Description
POST api/providers/{pid}/locations/{locationId}/serviceconfigs	Criar nova configuração de atendimento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}	Atualiza descrição da configuração de atendimento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/ticket-code	Atualiza formatação do código de atendimento.
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/selfservice-booking	Atualiza as políticas de agendamento para o autoatendimento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/selfservice-confirmation	Atualiza as políticas de confirmação para o autoatendimento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/selfservice-checkin	Atualiza as políticas de confirmação para o autoatendimento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/transfer-ticket	Atualiza as configurações de transferência de bilhetes
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}	Obtém a configuração de atendimetno
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/previsions	No documentation available.
GET api/providers/{pid}/locations/{locationId}/serviceconfigs?ignoreUser={ignoreUser}	Obtém lista com todas as configurações de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/transfer	Obtém lista com todas as configurações de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/previsions?justToday={justToday}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/archived	Obtém lista de configurações de atendimento arquivadas.
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/service-room/{serviceRoomId}	Vincula sala de atendimento à configuração
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/services	Obtém lista de serviços que estão vinculados à configuração de atendimento.
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/archive	Arquiva a configuração de atendimento. Ao arquivar uma configuração de atendimento, todas as sessões desta configuração serão bloqueadas, dessa forma são será possível realizar agendamentos para esta configuração.
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/restore	Desarquiva a configuração de atendimento
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/services/{serviceId}	Vincula serviço à configuração de atendimento
DELETE api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/services/{serviceId}	Desvincula serviço da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/attendants	Obtém lista de atendentes "recursos" vinculados à configuração de atendimetno
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/attendants/{attendantId}	Vincula atendente à configuração de atendimento
DELETE api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/attendants/{attendantId}	Desvincula atendente da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/invitations	Obtém lista usuários convidados para serem atendentes vinculados à configuração de atendimento
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/invitations	Convida usuário para ser atendente vinculando-o à configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/terminals	Obtém lista de terminais de autoatendimento cuja configuração de atendimento está vinculada
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/terminals/{terminalId}	Vincula terminal de autoatendiento à configuração de atendimento
DELETE api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/terminals/{terminalId}	Desvincula terminal de autoatendimento da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/panels	Obtém lista de paineis de atendimento cuja configuração de atendimento está vinculada
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/panels/{panelId}	Vincula painel de atendimento à configuração de atendimento
DELETE api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/panels/{panelId}	Desvincula painel de atendimento da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/users	Obtém lista de usuários com permissão para atender na configuração de atendimento
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/users/{userId}	Dá permissão de atendente e vincula usuário à configuração de atendimento
DELETE api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/users/{userId}	Desvincula usuário da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/status	Obtém situação da configuração de atendimento
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/schedule?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/schedule/sessions?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/sessions	No documentation available.
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/payment-support	Atualiza as políticas de agendamento para pagamento
PUT api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/service-note	Atualiza observação da configuração de atendimento
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/webhooks	Adiciona um novo webhook a uma configuração de serviço
POST api/providers/{pid}/locations/{locationId}/serviceconfigs/{serviceConfigId}/authorizers	Adiciona um novo autorizador a uma service config