Schema di utilizzo

Il diagramma seguente mostra il flusso delle operazioni per integrare Corypha in un'applicazione di terze parti.

Schema

Esempio passo passo

Nella dashboard di Corypha si crea un testo legale chiamato ad esempio "Testo legale", il cui codice è "corypha-policy".
L'obbietivo è integrare il testo legale in un'app di terze parti tramite le API.

Fase 1

L'utente con ID 1 accede all'applicazione in cui è implementato Corypha. L'app, per sapere se l'utente ha nuovi consensi da fornire, chiama l'API

https://api.corypha.app/app/policies/{code}/users/{userid}/check

che nel caso specifico diventa

https://api.corypha.app/app/policies/corypha-policy/users/1/check

La risposta contiene il campo hasNewVersion. Se false, non ci sono nuovi consensi da fornire; se true, il campo version conterrà i nuovi consensi.

Per ID utente s'intende l'ID all'interno dell'app, non di Corypha.

Fase 2

L'implementatore deve mostrare all'utente i nuovi consensi. Per salvarli, l'app chiamerà l'API PUT

https://api.corypha.app/app/policies/{code}/users/{userid}

che in questo esempio diventa

https://api.corypha.app/app/policies/corypha-policy/users/1

il payload della richiesta sarà

{
  "preferences": [
    {
      "id": "1",
      "accepted": true
    },
    {
      "id": "2",
      "accepted": false
    }
  ]
}

dove id è in questo caso l'ID del consenso.