Signature

Development

We can support new signature provider.

Development

We can support new signature provider.

First we need some data:

  • id: unique identifier (3 to 5 letters)
  • name: short name
  • desc:
    • en: longer description in English
    • pt: longer description in Portugese
    • fr: longer description in French
  • url:
    • main:
    • support:
  • image:
  • tags:

Example :

id: cmd
name: Chave Móvel Digital
desc: The official portug
url:
    main: https://www.autenticacao.gov.pt/a-chave-movel-digital
    support: https://www.autenticacao.gov.pt/contactos
image:

frontend settings

We need a setting component that will be shown in user settings: /settings/signature

Example vue component: ppw-sign-cmd-settings.

frontend sign

We need a signature component that will be show in the finalization step of a craft form.

Example vue component: ppw-sign-cmd-sign.

backend

We need some API endpoints that will be called by the frontend pages.

Example API endpoint: /api/sign/cmd

documentation

We need some documents on the signature provider.

Example docs: /docs/signature/providers/cmd

common frontend components

The custom provider components are used in common frontend components.

  • ppw-sign-provider: to display a single signature provider
  • ppw-sign-providers: to display a list of signature provider (or select)
  • ppw-sign-accounts: to display a list of signature accounts (or select)
  • ppw-sign-account: to display the detail of a signature account (or edit, combined view of all ppw-sign-xxxx-settings)
  • ppw-sign-document: to sign a document with a given signature account (combined view of all ppw-sign-xxxx-sign))

All those components can be tested in page /debug/ppw/sign