View Categories

API REST – Liens d’action

3 minutes

0:00 2:51

Un lien d’action permet à un destinataire sans compte de confirmer une action prévue sur une fiche : accepter un devis, clore un ticket, se désinscrire. L’adresse renvoyée ouvre une page de confirmation ; la fiche n’est modifiée qu’au clic sur Confirmer, une seule fois, pendant 30 jours. Fonctionnement détaillé : Les liens d’action dans les e-mails.

Un lien ne donne jamais plus de droits que son créateur : il faut pouvoir faire soi-même la modification, comme à l’écran. C’est le droit de modifier la fiche et le champ, ou, sur un devis, une commande ou une facture finalisés, la Modification partielle du champ (la phase d’un devis envoyé, par exemple).

Lister les actions possibles #

GET https://apps.kafinea.com/{instance}/webservice.php

Paramètre Type Requis Description
operation string oui action_link_actions
sessionName string oui Identifiant de session
module string non Module des fiches visées, par exemple Quotes 
curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=action_link_actions&sessionName=YOUR_SESSION_ID&module=Quotes"

La réponse contient actions (module, action, libellé, attributs, durée de vie en jours ; * désigne une action disponible sur tous les modules). Avec module, elle contient aussi settableFields : les listes déroulantes et cases à cocher que vous pouvez faire modifier par un lien, avec leurs valeurs.

Créer un lien #

POST https://apps.kafinea.com/{instance}/webservice.php

Paramètre Type Requis Description
operation string oui action_link_create
sessionName string oui Identifiant de session
id string oui ID Webservice de la fiche
action string oui Action à proposer, par exemple set-field
attributes JSON selon l’action Pour set-field : field, value et, facultatif, une question courte affichée sur la page 
curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=action_link_create" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d "id=4x1234" \
  -d "action=set-field" \
  --data-urlencode 'attributes={"field":"quotestage","value":"Accepted","question":"Acceptez-vous ce devis ?"}'

{
  "success": true,
  "result": {
    "url": "https://apps.kafinea.com/YourKafinea/shorturl.php?id=9f2c…",
    "expiresAt": "2026-11-24T10:00:00+00:00",
    "module": "Quotes",
    "action": "set-field",
    "id": "4x1234"
  }
}

Créer le lien ne modifie pas la fiche. Remettez l’adresse uniquement à son destinataire : quiconque la détient peut confirmer l’action.

Règles et erreurs #

  • value doit être une valeur de la liste (la valeur enregistrée, Accepted, et non le libellé affiché) ou 1 / 0 pour une case à cocher.
  • La fiche visée est toujours celle de id : attributes ne peut pas la changer.
  • Une demande que le lien ne pourrait jamais exécuter (champ non modifiable par lien, valeur inconnue, question trop longue) ou que vous ne pourriez pas faire vous-même est refusée avec le code ACTION_LINK_INVALID.
  • Sans droit de lecture sur la fiche, la réponse est ACCESS_DENIED.

Références associées #