Référence de l'API DeMark

Notions de base

Authentification

Créez vos clés dans Paramètres > Développeurs et envoyez-les dans l'en-tête Authorization. Une clé révoquée cesse de fonctionner aussitôt.

dmk_live_... Clé secrète : seulement depuis votre serveur. Elle est refusée si un navigateur l'envoie.
dmk_pk_... Clé publique : sans danger dans votre HTML. Elle lit les services, les disponibilités, les produits et les événements, et crée des réservations, des demandes, des paniers, des inscriptions et des tours de clavardage, seulement depuis les domaines autorisés.

Authorization: Bearer dmk_live_...

Erreurs

Toutes les erreurs ont le même corps : un code générique (unauthorized, forbidden, not_found, conflict, validation, rate_limited) et un motif dans message. Les erreurs de validation listent les champs.

{
  "error": {
    "code": "validation",
    "message": "invalid_fields",
    "fields": {
      "email": "invalid_email"
    }
  }
}

Pagination

Les listes renvoient data et next_cursor. Renvoyez next_cursor dans ?cursor= pour la page suivante ; limit va de 1 à 100 (25 par défaut). Un next_cursor nul veut dire que vous êtes à la fin.

{
  "data": [
    "..."
  ],
  "next_cursor": "MTAx"
}

Dates et heures

Les heures sont en ISO 8601 avec le décalage du fuseau de l'entreprise. Vous pouvez envoyer toute heure ISO 8601 avec un décalage ou Z ; sans décalage, elle est lue dans le fuseau de l'entreprise.

Limites de débit

600 requêtes par minute par clé. Chaque réponse porte X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset ; au-delà, vous recevez 429 avec Retry-After.

Compte

L'entreprise et la clé que vous utilisez.

GET `/api/v1/me`

L'entreprise et la clé de la requête

Fonctionne avec une clé publique

Réponses

200 Successful Response
401 Missing, invalid or revoked API key
403 Forbidden: key type, permission, origin or plan
429 Rate limited

Exemple de réponse (200)

{
  "business": {
    "id": 12,
    "slug": "salon-ana",
    "name": "Salon Ana",
    "languages": [
      "en",
      "fr"
    ],
    "timezone": "America/Moncton",
    "currency": "CAD",
    "booking_url": "https://demarkstudio.ca/salon-ana/book",
    "site_url": "https://www.salonana.ca"
  },
  "key": {
    "name": "Website",
    "prefix": "dmk_pk_ab12c",
    "type": "public",
    "permissions": [
      "reservas",
      "solicitudes"
    ],
    "scopes": [
      "bookings:create",
      "requests:create",
      "services:read"
    ]
  }
}

Essayez avec curl

curl -X GET "https://demarkstudio.ca/api/v1/me" \
  -H "Authorization: Bearer dmk_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Nom	Dans	Type	Obligatoire	Description
`lang`	requête	`string \| null`	Non	en or fr; without it, Accept-Language.
`cursor`	requête	`string \| null`	Non
`limit`	requête	`integer`	Non	Defaults to the maximum: most businesses fit in one page.

Nom	Dans	Type	Obligatoire	Description
`service`	requête	`integer`	Oui	Service id.
`date`	requête	`string`	Oui	Local day, YYYY-MM-DD.
`staff`	requête	`integer \| null`	Non	Staff id; omit for anyone.
`location`	requête	`string \| null`	Non	Location id or slug (GET /locations); omit for the primary location.

Nom	Dans	Type	Obligatoire	Description
`from`	requête	`string \| null`	Non	Start day or datetime (ISO).
`to`	requête	`string \| null`	Non	End day (exclusive) or datetime (ISO).
`status`	requête	`string \| null`	Non	pending, confirmed, cancelled, completed or no_show.
`location`	requête	`integer \| null`	Non	Only this location's bookings (GET /locations).
`cursor`	requête	`string \| null`	Non
`limit`	requête	`integer`	Non

Nom	Dans	Type	Obligatoire	Description
`booking_id`	chemin	`integer`	Oui
`token`	requête	`string \| null`	Non	Management token. Required with a public key or without a key.

Nom	Type	Obligatoire	Description
`start`	`string \| null`	Non	New start (ISO 8601), from GET /availability/slots. Reschedules the booking: this id is cancelled and a new one is created (see the returned id). Omit to only update notes.
`notes`	`string \| null`	Non
`location`	`integer \| null`	Non	Move the booking to this location (GET /locations). Works like a reschedule: with start, at that time; without it, at the same time. The staff member must work there, the service's room must be one of that location's, and the time must be free there (a staff member's bookings at every location count).

Nom	Dans	Type	Obligatoire	Description
`service_id`	requête	`integer`	Oui
`from`	requête	`string`	Oui	First local day, YYYY-MM-DD.
`to`	requête	`string`	Oui	Last local day, YYYY-MM-DD (inclusive).
`staff_id`	requête	`integer \| null`	Non
`location`	requête	`string \| null`	Non	Location id or slug (GET /locations); omit for the primary location.

Nom	Type	Obligatoire	Description
`from_booking`	`integer \| null`	Non	Cancel this booking and the following ones. Omit to cancel every booking of the series that has not started yet.
`notify`	`boolean`	Non	Email the customer one message with the cancelled dates.

Nom	Type	Obligatoire
`name_en`	`string`	Oui
`name_fr`	`string`	Non
`description_en`	`string`	Non
`description_fr`	`string`	Non
`duration_min`	`integer`	Non
`price`	`number`	Non

Nom	Type	Obligatoire	Description
`type`	`string`	Non	quote, contact or support.
`name`	`string`	Oui
`email`	`string`	Oui
`phone`	`string \| null`	Non
`subject`	`string \| null`	Non
`message`	`string`	Oui
`attachment`	`Adjunto \| null`	Non
`attachments`	`array[Adjunto] \| null`	Non	Up to 3 files (together with attachment).
`lang`	`string \| null`	Non
`page_url`	`string \| null`	Non

Nom	Type	Obligatoire	Description
`items`	`array[LineaCompra]`	Oui
`customer`	`ClientePedido`	Oui
`delivery`	`string \| null`	Non	pickup, shipping or digital.
`shipping_address`	`string \| null`	Non
`notes`	`string \| null`	Non
`lang`	`string \| null`	Non

Nom	Dans	Type	Obligatoire	Description
`product_id`	chemin	`integer`	Oui	Product id.
`Idempotency-Key`	en-tête	`string`	Non	Retry safely: the first 2xx response is kept 24 hours and replayed with Idempotent-Replayed: true. Same key with a different body: 422 idempotency_key_reused.

Nom	Type	Obligatoire	Description
`id`	`string \| null`	Non	Group id (slug). Omit it to derive it from name_en.
`name_en`	`string`	Oui
`name_fr`	`string \| null`	Non	Defaults to name_en.
`mode`	`string`	Non	surcharge adds amount_cents; price sets the price. At most one price group per product.
`options`	`array[OptionInput]`	Oui

Nom	Type	Obligatoire	Description
`options`	`object`	Oui	One option per group: {group id: option id}.
`sku`	`string \| null`	Non
`price_cents`	`integer \| null`	Non	Fixed price; null = calculated from the product price and the option amounts.
`stock`	`integer \| null`	Non	Own stock; null = shares the product stock.
`active`	`boolean`	Non	An inactive variant is kept but cannot be bought.

Nom	Type	Obligatoire	Description
`status`	`string`	Oui	preparing, ready, shipped, delivered, cancelled, refunded, or paid (only with manual_payment).
`manual_payment`	`boolean`	Non	Required (true) to mark an order paid: payment taken outside DeMark. Audited.
`tracking`	`string \| null`	Non	Tracking number for shipped.

Nom	Dans	Type	Obligatoire	Description
`invoice_id`	chemin	`integer`	Oui
`Idempotency-Key`	en-tête	`string`	Non	Retry safely: the first 2xx response is kept 24 hours and replayed with Idempotent-Replayed: true. Same key with a different body: 422 idempotency_key_reused.

Nom	Type	Obligatoire	Description
`method`	`string`	Oui
`reference`	`string \| null`	Non
`paid_at`	`string \| null`	Non	ISO 8601; defaults to now.

Nom	Type	Obligatoire	Description
`occurrence`	`string`	Oui	Occurrence id from /events, or its date YYYY-MM-DD.
`name`	`string`	Oui
`email`	`string`	Oui
`phone`	`string \| null`	Non
`seats`	`integer`	Non
`lang`	`string \| null`	Non

Nom	Type	Obligatoire	Description
`session`	`string \| null`	Non	Omit on the first turn; send back the one you get.
`message`	`string`	Non
`action`	`string \| null`	Non	An option id from the previous reply.
`fields`	`object \| null`	Non	Form values: nombre, email, detalle.
`lang`	`string \| null`	Non
`page_url`	`string \| null`	Non

Nom	Type	Obligatoire	Description
`id`	`integer`	Oui
`filename`	`string`	Oui
`content_type`	`string`	Oui
`size`	`integer`	Oui	Bytes.
`url`	`string`	Oui	Signed download link; no key needed until expires_at.
`expires_at`	`string`	Oui	ISO 8601; ask for the request again to get a fresh url.

Nom	Type	Obligatoire	Description
`id`	`string`	Oui	Occurrence id: <event_id>-<YYYY-MM-DD>.
`event_id`	`integer`	Oui
`title`	`string`	Oui	In the requested language.
`description`	`string`	Oui
`start`	`string`	Oui
`end`	`string`	Oui
`seats_left`	`integer \| null`	Oui	null = no capacity limit.
`price`	`string \| null`	Oui
`currency`	`string`	Oui
`url`	`string`	Oui	Event page in the requested language.

Référence de l'API

Notions de base

Authentification

Erreurs

Pagination

Dates et heures

Limites de débit

Compte

GET /api/v1/me

Réponses

Réservations

GET /api/v1/services

Paramètres

Réponses

GET /api/v1/availability

Paramètres

Réponses

GET /api/v1/locations

Réponses

POST /api/v1/bookings

Paramètres

Corps de la requête

Réponses

GET /api/v1/bookings

Paramètres

Réponses

GET /api/v1/bookings/{booking_id}

Paramètres

Réponses

DELETE /api/v1/bookings/{booking_id}

Paramètres

Réponses

PATCH /api/v1/bookings/{booking_id}

Paramètres

Corps de la requête

Réponses

GET /api/v1/availability/slots

Paramètres

Réponses

POST /api/v1/booking-series

Paramètres

Corps de la requête

Réponses

GET /api/v1/booking-series/{series_id}

Paramètres

Réponses

POST /api/v1/booking-series/{series_id}/cancel

Paramètres

Corps de la requête

Réponses

Services

POST /api/v1/services

Paramètres

Corps de la requête

Réponses

GET /api/v1/services/{service_id}

Paramètres

Réponses

PATCH /api/v1/services/{service_id}

Paramètres

Corps de la requête

Réponses

Demandes

POST /api/v1/requests

Paramètres

Corps de la requête

Réponses

GET /api/v1/requests

Paramètres

Réponses

Clients

GET /api/v1/customers

Paramètres

Réponses

POST /api/v1/customers

Paramètres

Corps de la requête

Réponses

GET /api/v1/customers/{customer_id}

Paramètres

GET `/api/v1/me`

GET `/api/v1/services`

GET `/api/v1/availability`

GET `/api/v1/locations`

POST `/api/v1/bookings`

GET `/api/v1/bookings`

GET `/api/v1/bookings/{booking_id}`

DELETE `/api/v1/bookings/{booking_id}`

PATCH `/api/v1/bookings/{booking_id}`

GET `/api/v1/availability/slots`

POST `/api/v1/booking-series`

GET `/api/v1/booking-series/{series_id}`

POST `/api/v1/booking-series/{series_id}/cancel`

POST `/api/v1/services`

GET `/api/v1/services/{service_id}`

PATCH `/api/v1/services/{service_id}`

POST `/api/v1/requests`

GET `/api/v1/requests`

GET `/api/v1/customers`

POST `/api/v1/customers`

GET `/api/v1/customers/{customer_id}`

PATCH `/api/v1/customers/{customer_id}`

GET `/api/v1/products`

POST `/api/v1/carts`

POST `/api/v1/orders`

POST `/api/v1/products`

GET `/api/v1/products/{product_id}`

PATCH `/api/v1/products/{product_id}`

POST `/api/v1/products/{product_id}/publish`

POST `/api/v1/products/{product_id}/unpublish`

POST `/api/v1/products/{product_id}/option-groups`

PATCH `/api/v1/products/{product_id}/option-groups/{group_id}`

DELETE `/api/v1/products/{product_id}/option-groups/{group_id}`

POST `/api/v1/products/{product_id}/variants`

PATCH `/api/v1/products/{product_id}/variants/{variant_id}`

GET `/api/v1/shop/policies`

GET `/api/v1/orders`

GET `/api/v1/orders/{order_id}`

PATCH `/api/v1/orders/{order_id}/status`