Salta al contingut

Desenvolupadors

Primers passos

Activa les integracions, crea una credencial i fes la teva primera crida a l'API de Pranarp Club.

L'API pública de Pranarp Club és una API JSON sobre HTTPS. Pranarp Club és la font de veritat d'espais, horaris, preus i reserves; el teu sistema ho és dels teus clients i dels cobraments. Aquesta guia et porta de zero a la teva primera crida.

1. Activa les integracions

L'accés a l'API és una funció de pagament del club (un complement) anomenada integrations. Si el teu club encara no la té, demana-la al nostre equip a hello@pranarp.com. Mentre no estigui activa, qualsevol crida respon 403 amb el codi feature_disabled.

Per fer proves sense tocar les dades reals d'un club, mira l'entorn de proves.

2. Crea una credencial

  1. Entra al tauler del club amb un usuari que tingui el permís integrations.manage («Manage Integrations»), que per defecte només té el rol Owner (propietari) del club.
  2. Ves a Configuració → Integracions.
  3. A Crea una credencial, posa-hi un nom (per exemple «Web del club»), tria els permisos que necessites i, si vols, limita la credencial a alguns espais i posa-hi una data de caducitat.
  4. Copia el token (pck_live_…). Es mostra una sola vegada: si el perds, revoca la credencial i crea'n una altra.

Desa el token com a secret al teu servidor. No el posis mai en codi que s'executi en un navegador o en una app mòbil. Els permisos disponibles s'expliquen a Autenticació.

3. La teva primera crida

L'URL base és el mateix host que fas servir per entrar al tauler, amb el prefix /api/v1. Als exemples d'aquestes guies fem servir dues variables d'entorn:

export PRANARP_URL="https://la-teva-instalacio.example"   # el host del teu Pranarp Club
export PCK_TOKEN="pck_live_xxxxxxxxxxxxxxxx"              # el token que acabes de copiar

Comprova que el token funciona amb GET /me, que no necessita cap permís especial:

curl -s "$PRANARP_URL/api/v1/me" \
  -H "Authorization: Bearer $PCK_TOKEN" \
  -H "Accept: application/json"

Resposta:

{
  "data": {
    "name": "Web del club",
    "token_prefix": "pck_live_AbCd1234",
    "abilities": ["spaces:read", "availability:read", "bookings:read", "bookings:write"],
    "space_ids": null,
    "expires_at": null,
    "club": { "id": 12, "name": "Club Pàdel Demo" }
  }
}

space_ids: null vol dir que la credencial pot fer servir tots els espais del club. Si reps 401 o 403, revisa la guia d'errors.

4. Següent pas: llista els espais

Amb el permís spaces:read:

curl -s "$PRANARP_URL/api/v1/spaces?limit=10" \
  -H "Authorization: Bearer $PCK_TOKEN"

A partir d'aquí, el flux habitual d'una integració de reserves és:

  1. Llistar els espais i consultar-ne la disponibilitat.
  2. Sincronitzar els jugadors amb PUT /players/{external_ref}.
  3. Crear la reserva amb POST /bookings enviant una capçalera Idempotency-Key.
  4. Rebre els canvis per webhooks en lloc de consultar l'API contínuament.

La referència de l'API descriu cada operació, i l'historial de canvis recull les novetats.