7.1. Plugin “electronicsignature”

Ce connecteur permet et le logiciel openADS.

7.1.1. Description de la configuration du connecteur electronicsignature

La configuration du plugin est définie dans dyn/electronicsignature.inc.php.

Modèle de fichier de configuration :

$conf["electronicsignature-default"] = array (
    "unexpected_collectivite" => array(),
    "1" => array(
        'connector' => '',
        'path' => '',
        'url_base' => 'https://localhost/',
        'debug' => false,
        'insecure' => false,
    ),
);

Liste des paramètres obligatoires :

  • connector Nom du connecteur
  • path Chemin du répertoire contenant la classe du connecteur
  • url_base URL de base de l’API
  • debug Active ou désactive la journalisation des requêtes sortantes et des retours (true | false)
  • insecure Active ou désactive la vérification du certificat SSL/TLS lors de la connexion au serveur distant (true | false)

Paramètres à saisir dans le signataire arrêté :

Le champ se nomme « Paramètre du parapheur », dans le cas d’un connecteur Pastell iParapheur il faut saisir ce paramètre :

{"circuit" : "SIGNATURE"}

Le circuit peut être différent en fonction du signataire.

Pour plus d’informations concernant le fonctionnement dans openADS, voir la partie Paramétrage d’un signataire arrêté et la partie Envoi du document en signature sur le parapheur.

7.1.1.1. Méthodes

7.1.1.1.1. send_for_signature()

send_for_signature(array $data, string $file_content, array $dossier_metadata, array $optional_data = null)

Permet à openADS d’envoyer un document d’instruction en signature dans le parapheur.

7.1.1.1.1.1. Paramètres

(array) $data Liste des paramètres génériques du connecteur.

(string) $file_content Contenu du document à signer.

(array) $dossier_metadata Métadonnées du dossier d’instruction.

(array) $optional_data Paramètres spécifique au connecteur.

7.1.1.1.1.2. Retour

(array) Tableau de résultat retourné par le connecteur parapheur, sinon retourne une exception.

7.1.1.1.2. get_signature_status()

get_signature_status(array $data)

Permet à openADS de récupérer le statut de signature du parapheur.

7.1.1.1.2.1. Paramètres

(array) $data Tableau contenant l’identifiant du parapheur.

7.1.1.1.2.2. Retours

(array) Tableau de résultat retourné par le connecteur parapheur, sinon retourne une exception.

7.1.1.1.3. cancel_send_for_signature()

cancel_send_for_signature(array $data)

Permet à openADS d’annuler l’envoi en signature au parapheur.

7.1.1.1.3.1. Paramètres

(array) $data Tableau contenant l’identifiant du parapheur.

7.1.1.1.3.2. Retours

(array) Tableau de résultat retourné par le connecteur parapheur, sinon retourne une exception.

7.1.1.1.4. get_signed_document()

get_signed_document(array $data)

Permet à openADS de récupérer le document signé présent dans le parapheur.

7.1.1.1.4.1. Paramètres

(array) $data Tableau contenant l’identifiant du parapheur.

7.1.1.1.4.2. Retours

(array) Tableau de résultat retourné par le connecteur parapheur, sinon retourne une exception.