Calendar
A sua agenda, páginas de marcação e serviços.
O Calendar tem métodos públicos para os dois lados de uma reserva. Alguns atuam por si, o proprietário, e levam a sua chave de API: leem a sua configuração e as suas reservas, configuram recursos, serviços e páginas, retêm e confirmam uma hora, cancelam e alteram o plano. Outros são os que uma página de reservas faz por um visitante. Não precisam de chave, apenas da chave da página.
A partilha de calendários com outras pessoas, as vistas, as tarefas, os eventos do dia e as Configurações do Calendário fazem-se no dashboard. Hoje não têm método público.
Envie um pedido a um método com a sua chave:
Uma boa resposta tem code 1. Uma alteração que o seu plano não inclui é recusada com code -62 e uma frase em data, por exemplo que as sessões de grupo precisam do Growth ou que o seu plano comporta um número de páginas de reservas. Para atuar no calendário de uma conta que o partilhou consigo ao nível de edição, passe o seu share_id aos métodos que o aceitam.
Ler a sua configuração e reservas
get_calendar_setupresponde, numa só chamada, a tudo o que os ecrãs do Calendar desenham: as pessoas e salas reserváveis com os seus horários, os serviços e as páginas de reservas publicadas com os seus endereços públicos.get_calendar_bookingslista reservas, as próximas por omissão. Passepastcomotruepara as que já aconteceram, a mais recente primeiro, elimitpara quantas. Cada linha traz a hora no fuso do recurso, os dados do convidado e tudo o que ele disse ao reservar.get_calendar_slotslista as horas reserváveis de um serviço num recurso entrefrom_tseto_ts(milissegundos desde a época), sem tudo o que já está ocupado.
Configurar o que pode ser reservado
save_calendar_resourcecria ou atualiza algo que pode ser reservado: uma pessoa, uma sala, uma cadeira ou um dispositivo. Precisa de umtimezone, um fuso IANA comoAsia/Jerusalem, e o seu horário é lido nesse fuso. Omitaresource_idpara criar um novo.save_calendar_servicecria ou atualiza o que as pessoas podem reservar: a sua duração, margens, antecedência, com quanta antecedência pode ser reservado, lugares, onde decorre (meeting_kind) e, comprice_cents,currencyecheckout, quanto custa e se é pago na reserva. Mais do que um lugar exige um plano que inclua sessões de grupo, e receber pagamentos exige um plano que inclua pagamentos.save_calendar_pagecria ou atualiza uma página de reservas: o seutitle,intro, osservice_idsque oferece, se estáenabled, a sua coraccent,show_host, se os visitantes podem alterar a sua reserva (visitor_changes,change_hours,refund_percent) e a conta financeira para onde é paga (finance_account_id). Criar uma página além do limite de páginas do seu plano é recusado.delete_calendar_itemremove um recurso, um serviço ou uma página poritem_id. As reservas nunca são eliminadas desta forma: são canceladas.
Reservar uma hora você mesmo
Reservar a partir do seu próprio código são dois passos, para que uma hora nunca seja vendida duas vezes.
Retenha a hora
hold_calendar_slot reserva uma hora durante alguns minutos. Passe resource_id, service_id e start_utc (milissegundos desde a época). Uma boa resposta tem data com occ_id, hold_token e expires_at. Envie uma idem_key para que uma repetição da chamada devolva a mesma retenção em vez de ocupar um segundo lugar.
Confirme-a
confirm_calendar_booking transforma a retenção numa reserva. Passe o occ_id e o hold_token da retenção, e o name, email, phone e note do convidado. Uma retenção que já não existe perdeu a hora e é recusada.
Alterar uma reserva
cancel_calendar_bookingcancela porbooking_ide devolve a hora à grelha pública. É seguro chamá-lo duas vezes. Só liberta a hora: não envia email ao convidado nem reembolsa um pagamento, o que o Cancelar compromisso do dashboard faz para um convidado que reservou através da sua página.notify_calendar_guestsenvia email a todos os convidados de uma reserva, uma mensagem a cada um, com o convite de calendário anexado e umamessageopcional até 2000 carateres.kindéinvitepara uma nova marcação eupdatepara uma alteração, que é o valor por omissão. O email sai da sua própria caixa de correio num plano que a inclui, e do endereço de reservas da Xuda caso contrário, com o seu endereço como resposta.create_booking_roomcria a sala Xuda Meet de uma reserva de vídeo confirmada que não tem nenhuma, e envia a cada convidado a ligação.
O que uma página de reservas chama
Uma página de reservas funciona com a sua chave de página, <uid>.<page_id>, e sem conta.
get_booking_bootstrapresponde ao que uma página precisa para se desenhar: o seu título, os seus serviços e um novo token anti-bot.get_public_booking_slotslista as horas que um visitante pode escolher, cada uma com um início, um fim e uma contagem de lugares. Nunca diz quem ocupa os outros lugares.public_book_slotaceita uma reserva de um visitante. Passe opage_key,service_id,start_utc, otoken, e onameeemaildo visitante. Acrescente umaidem_keypara que um duplo clique não reserve duas vezes.company_websiteé uma armadilha para bots: deixe-o vazio.- Para um serviço pago na reserva,
public_start_paid_bookingretém a hora e inicia o pagamento,start_booking_paymentenvia uma hora retida para o Stripe, epublic_confirm_paid_bookingeconfirm_paid_bookingreservam-na quando o pagamento foi concluído. O pagamento é lido de volta do Stripe antes de qualquer reserva. - Um visitante gere uma reserva a partir da ligação privada no seu email.
get_public_booking,public_cancel_bookingepublic_reschedule_bookingrecebem a chave da página e o valormanagedessa ligação. Seguem as regras da página: se os visitantes podem alterar uma reserva e até quantas horas antes de começar. Uma reserva paga é primeiro reembolsada, pela percentagem de reembolso da página.
O plano
get_calendar_plans responde com os quatro níveis, com os seus preços e o que cada um inclui, em que plano está e se o Calendar está ativo. calendar_set_plan ativa-o, altera o nível ou desativa-o: passe plan_id como calendar_free, calendar_starter, calendar_growth ou calendar_business, ou defina deactivate como true. Consulte Planos e faturação.