Udviklere
Dine data er dine. Læs og ret dem gennem GraphQL-API'et, og få en signeret webhook, når der sker noget.
API-tokens
Opret et token i Kontrolpanel under Data og integrationer, og vælg, hvad det må læse eller ændre. Send det som et Bearer-token til din virksomheds /graphql-endpoint. Det fulde skema findes på /graphql/schema.
curl https://your-business.appointier.com/graphql \
-H "Authorization: Bearer $APPOINTIER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"query":"{ customers(first: 5) { edges { node { firstName lastName email } } } }"}'Rettigheder
Et token bærer de rettigheder, du vælger. Rapporter og indstillinger er skrivebeskyttede; alle andre områder har en læse- og en skriverettighed. Rollen for den, der oprettede tokenet, afgrænser stadig, hvad det kan nå.
- read
- write
- customers.read
- customers.write
- appointments.read
- appointments.write
- catalog.read
- catalog.write
- packages.read
- packages.write
- sales.read
- sales.write
- invoices.read
- invoices.write
- reports.read
- settings.read
Webhooks
Hver levering har en Appointier-Signature-header med et tidsstempel og en HMAC-SHA256 af tidsstemplet og den rå body, nøglet med hemmeligheden for dit endpoint. Afvis alt, der er ældre end fem minutter.
import crypto from "node:crypto";
export function verify(body, header, secret, toleranceSeconds = 300) {
const parts = Object.fromEntries(header.split(",").map((part) => part.split("=")));
const age = Math.abs(Date.now() / 1000 - Number(parts.t));
if (age > toleranceSeconds) return false;
const expected = crypto
.createHmac("sha256", secret)
.update(`${parts.t}.${body}`)
.digest("hex");
return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}Hændelser
- appointment.created
- appointment.updated
- appointment.canceled
- appointment.completed
- appointment.no_show
- customer.created
- customer.updated
- sale.completed
- sale.voided
- package.sold
- package.redeemed
- package.reversed
- invoice.paid
En mislykket levering forsøges igen efter 1 minut, 5 minutter, 30 minutter, 2 timer og 12 timer. Efter 10 fejl i træk sættes endpointet på pause, og ejeren får en mail. Enhver levering kan sendes igen fra loggen.
Fuld eksport
Ejere kan anmode om en ZIP-fil med alle tabeller som CSV og JSON Lines samt fotos, underskrevne formularer, note-PDF'er og en oversigt med antal rækker. Linket kommer på mail og virker i 24 timer.
- customers
- appointments
- catalog
- staff
- locations
- packages
- memberships
- gift_cards
- forms
- notes
- products
- sales
- invoices
- payments
- notifications
- audits
Den samme ZIP-fil kan leveres hver dag eller hver uge til en Amazon S3-bucket, et S3-kompatibelt lager eller en SFTP-server.
Grænser for forespørgsler
Hvert token kan lave 600 forespørgsler i minuttet, og hvert svar indeholder X-RateLimit-Limit og X-RateLimit-Remaining.