API · Agendamentos e reservas

Ligue a sua agenda ao SellViaApp

Gira serviços, recursos, horários, indisponibilidades, vagas e reservas a partir do seu próprio software.

Início rápido

Autenticar, escolher uma rota, testar.

Obtenha a X-API-Key e gere o token Bearer em Dashboard → API. Introduza ambos abaixo. Depois, selecione «Testar · Gerar» num endpoint para consultar a resposta e o código de exemplo em cURL, PHP 8 ou JavaScript.

Credenciais incompletasDigite o token X-API-Key e Bearer para preparar um teste.

As credenciais permanecem em memória apenas para esta página. Para uma operação relacionada ao cliente, adicione customer_id.

Keep in mindHTTPS + JSON · mantenha ambas as credenciais do lado do servidor · nunca envie tokens para suporte.

Pontos finais

Nomeações e reservas

Configure serviços, recursos, horários e reservas do aplicativo móvel, um ERP ou software de negócios.

33 routes
GET /booking/config/get Chave + Carregador

Leia as regras de reserva e a moeda do aplicativo.

PATCH /booking/config/update Chave + Carregador

Atualizar as regras de aviso, cancelamento e lembrete. A confirmação de dois passos permanece sempre ativa.

GET /booking/service-category/list Chave + Carregador

Listar categorias de serviços e subcategorias.

POST /booking/service-category/add Chave + Carregador

Criar uma categoria ou subcategoria principal.

PATCH /booking/service-category/update Chave + Carregador

Atualizar uma classificação de categoria de serviço.

DELETE /booking/service-category/delete Chave + Carregador

Apagar uma categoria não utilizada ou arquivá- la.

GET /booking/service/list Chave + Carregador

Listar os serviços de reserva e os recursos elegíveis.

GET /booking/service/detail Chave + Carregador

Recuperar uma descrição detalhada serviço e galeria de fotos.

POST /booking/service/add Chave + Carregador

Crie um serviço com duração, preço e recursos.

POST /booking/service/photo/add Chave + Carregador

Adicionar uma foto a uma galeria de serviços.

DELETE /booking/service/photo/delete Chave + Carregador

Apagar uma foto de serviço.

PATCH /booking/service/photo/primary Chave + Carregador

Selecione a foto principal mostrada na lista móvel.

PATCH /booking/service/update Chave + Carregador

Atualizar um serviço bookable.

DELETE /booking/service/delete Chave + Carregador

Apagar um serviço não utilizado ou arquivá- lo.

GET /booking/resource/list Chave + Carregador

Listar pessoas, salas, veículos, equipamentos e recursos de capacidade.

POST /booking/resource/add Chave + Carregador

Criar um recurso bookable.

PATCH /booking/resource/update Chave + Carregador

Atualizar um recurso.

DELETE /booking/resource/delete Chave + Carregador

Apagar um recurso não utilizado ou arquivá- lo.

GET /booking/availability/list Chave + Carregador

Listar horários semanais.

POST /booking/availability/add Chave + Carregador

Adicione uma programação geral, específica do serviço ou específica do recurso.

DELETE /booking/availability/delete Chave + Carregador

Apagar um horário.

GET /booking/unavailability/list Chave + Carregador

Listar feriados, encerramentos e períodos bloqueados.

POST /booking/unavailability/add Chave + Carregador

Bloquear um período geral ou específico de recursos.

DELETE /booking/unavailability/delete Chave + Carregador

Apagar uma indisponibilidade.

GET /booking/slot/list Chave + Carregador

Listar slots disponíveis e slots temporariamente pendentes confirmação do administrador.

GET /booking/list Chave + Carregador

Lista de reservas autorizadas.

GET /booking/detail Chave + Carregador

Recuperar uma reserva e sua história.

POST /booking/create Chave + Carregador

Crie e confirme a solicitação do cliente; a aprovação do administrador ainda é necessária.

POST /booking/customer-confirm Chave + Carregador

Confirme uma reserva no lado do cliente.

POST /booking/admin-confirm Chave + Carregador

Confirme, retorne à reserva pendente ou rejeite a reserva do lado do administrador.

PATCH /booking/update Chave + Carregador

Remarcar ou atualizar uma reserva.

PATCH /booking/status/update Chave + Carregador

Avance uma reserva que já foi confirmada por ambos os lados.

POST /booking/cancel Chave + Carregador

Cancelar de acordo com o prazo configurado.

Pontos finais

Pagamentos aos clientes

Escolha pagar na entrega ou abra um pagamento seguro Stripe, em seguida, recupere seu status verificado pelo servidor.

4 routes
GET /payment/config Chave + Carregador

Recuperar os métodos de pagamento Stripe habilitados e o provedor de conta Stripe selecionado para o aplicativo.

POST /payment/checkout/create Chave + Carregador

Crie ou retome uma página Stripe Checkout para uma encomenda ou reserva por pagar do cliente autenticado. Se ainda puder ser alterada, a opção de pagamento na entrega é substituída em segurança.

POST /payment/pay-later Chave + Carregador

Grave o pagamento na entrega ou substitua um pagamento Stripe ainda aberto após sua sessão ser verificada e expirada com segurança.

GET /payment/status Chave + Carregador

Recuperar um status de pagamento; apenas o webhook Stripe assinado pode confirmá-lo como pago.

Reference

Respostas e erros

Em «Parâmetros e respostas», consulte os campos obrigatórios e opcionais, os códigos de estado e exemplos JSON. Uma lista vazia indica apenas que ainda não há dados. Não significa que o endpoint esteja indisponível.

400Pedido inválido
401Autenticação necessária
403Acesso negado
404Recurso ou rota não encontrado
409Conflito de negócios
422A validação falhou
429Muitos pedidos
5xxIncidente técnico

Área de trabalho da API

Endpoint

GET

O código gerado contém as credenciais introduzidas. Guarde-as no servidor e nunca partilhe uma captura sem as ocultar.

Pronto para testar