Hub para Programadores & API Pública
Tudo o que os programadores precisam para integrar o yAppointment nos seus próprios produtos — uma API REST pública, OAuth 2.1 para acesso delegado pelo utilizador, webhooks assinados e um TypeScript SDK pronto a usar.
Read the DocsUma Plataforma Completa para Programadores
Blocos de construção prontos para produção para ligar o yAppointment às suas aplicações, fluxos de trabalho e integrações
API REST Pública
Uma API REST limpa e previsível em /api/v1 para ler e escrever dados da sua empresa, reservas e clientes — com chaves de idempotência para que as tentativas repetidas nunca gerem reservas duplicadas.
- Leia e escreva dados de empresa, reservas e clientes
- Criação idempotente de reservas com chaves de idempotência
- Gira os seus endpoints de webhook de forma programática
- Preços devolvidos em unidades menores (cêntimos) para cálculos precisos
- Respostas JSON consistentes e bem estruturadas
OAuth 2.1 + PKCE
Permita que os seus utilizadores liguem a conta yAppointment à sua aplicação de forma segura com o fluxo Authorization-Code e PKCE — sem partilha de senhas, apenas acesso com âmbito definido.
- Fluxo Authorization-Code com PKCE para acesso delegado pelo utilizador de forma segura
- Âmbitos granulares: read/write:bookings e read/write:customers
- Acesso ao perfil e análises via read:profile e read:analytics
- Gestão de webhooks através do âmbito webhooks:manage
- Os utilizadores concedem acesso sem partilhar credenciais
Chaves de API de Servidor e Públicas
Emita chaves de servidor (yapp_sk_*) para integrações no backend e chaves públicas (yapp_pk_*) para uso no lado do cliente, com ambientes de produção e teste completamente separados.
- Chaves de servidor (yapp_sk_*) para chamadas de servidor para servidor de confiança
- Chaves públicas (yapp_pk_*) para uso seguro no lado do cliente
- Ambientes de produção e teste separados para desenvolver com confiança
- Rode as chaves a qualquer momento a partir do seu painel
- Teste com dados de sandbox antes de entrar em produção
Webhooks Assinados
Seja notificado no momento em que algo muda. O yAppointment entrega 9 tipos de eventos nos seus endpoints HTTPS com tentativas automáticas e rastreamento completo de entrega.
- 9 tipos de eventos que abrangem reservas, clientes, serviços e funcionários
- Eventos booking.created, booking.updated e booking.cancelled
- Endpoints exclusivamente HTTPS com um segredo de assinatura whsec_
- Assinaturas HMAC-SHA256 no cabeçalho yapp-signature
- Tentativas automáticas com rastreamento de entrega e entregas de teste a partir do painel
Getting Started
Start building with our SDK or REST API in minutes. Full documentation and interactive examples at developers.yappointment.com.
View Documentationimport { YAppointmentClient } from
'@lohisoftsro/yappointment-sdk';
const client = new YAppointmentClient({
apiKey: process.env.API_KEY,
baseUrl: 'https://api.yappointment.com'
});
// Create a booking
const booking = await client.bookings.create({
serviceId: 'srv_123',
customerId: 'cst_456',
startTime: '2025-07-01T10:00:00Z',
idempotencyKey: 'req_xyz789'
});
console.log('Booked:', booking.id);Criado para uma Excelente Experiência de Programador
As ferramentas e a documentação que tornam a integração do yAppointment rápida e agradável
TypeScript SDK
Salte o código repetitivo com o nosso TypeScript SDK oficial no npm — @lohisoftsro/yappointment-sdk — gerado diretamente a partir da nossa especificação OpenAPI, com suporte ESM e CJS.
Documentação Interativa para Programadores
Explore todos os endpoints em developers.yappointment.com com uma referência de API Scalar interativa que pode ler, pesquisar e experimentar enquanto constrói.
Modos Produção e Teste
Chaves de API de produção e teste separadas permitem-lhe criar e experimentar em segurança, mudando para produção quando estiver pronto — sem tocar em dados reais.
Tentativas Seguras
As chaves de idempotência tornam a criação de reservas segura para repetir, para que falhas de rede nunca resultem em marcações duplicadas.
Pronto para ver o que muda?
14 dias. Acesso completo. Sem cartão de crédito. O que tem a perder?
Empresários em toda a Europa substituíram o caos administrativo por uma única plataforma que realmente funciona. Junte-se a eles hoje.
14 dias de avaliação gratuita • Sem comissões — sempre • Cancele a qualquer momento