Integration

Le API permettono di integrare Corypha in un sito web o un'applicazione terza in modo semplice. Testi legali e configurazione sono salvati nella dashboard all'indirizzo https://my.corypha.app.

Non è necessario installare alcun software per usare Corypha, solo chiamare le API.

Diagramma di flusso

Il diagramma seguente mostra il flusso con cui vanno chiamate le API. Il presupposto necessario è la creazione di una policy seguendo la guida Creare una policy.

graph

Esempio

Dopo aver creato un testo legale il cui codice è "corypha-policy", lo si vuole integrare in un'app di terze parti tramite le API.

Fase 1

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

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

che nel caso specifico diventa

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

La risposta contiene il campo hasNewVersion booleano:

false, non ci sono nuovi consensi da fornire
true, il campo version conterrà i nuovi consensi.

Lo userId è un ID esterno.

Fase 2

Il sito web o l'applicazione di terze parti può mostrare all'utente la nuova versione della policy. L'utente fornisce i consensi e l'app chiama l'API PUT per inviarli a Coryhpa:

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

in questo esempio diventa

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

dove in body della richiesta ha un formato di questo tipo:

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

id è in questo caso l'ID del consenso, non lo userId.

Fase 3

L'utente vuole visualizzare la lista dei consensi forniti. Il sito web o l'applicazione chiama l'API GET: