API : Envoyer un contrat en un seul appel

Pour créer un contrat et l'envoyer directement en signature, on peut utiliser la méthode sendCommandPacket.

Une façon rapide d'appeler cette méthode est d'utiliser l'API REST sous la forme d'un HTTP POST

Pour utiliser l'API vous devez avoir votre token API, votre contrat en pdf et votre fichier sellsign. Ce fichier contient l'ensemble des informations et des opérations à exécuter, comme une macro par exemple.

Si vous avez des modèles de contrat dans votre licence, utilisez l'identifiant du bon modèle comme contract_definition_id pour votre contrat. Si vous souhaitez simplement envoyer un document PDF déjà prêt, vous pouvez utiliser le modèle de contrat standard "PDF ADHOC". L'appel suivant permet de le retrouver automatiquement pour une licence donnée :

Ce fichier formaté en JSON, contient votre contract_definition_id et les informations de votre signataire comme le number du destinataire du contrat, et ses informations générales ainsi que le nom du pdf correspondant au contrat.

Exemple de fichier sellsign

{
    "customer": {
        "number": "mycustomer65778", // l'identifiant de votre client, le destinataire du contrat, que vous définissez 
        "mode": 3,
        "contractor_id": -1,
        "vendor": "vendor_adress_email@calindasoftware.com", // transmit dans vos variables API
        "fields": [{
                "key": "firstname",
                "value": "Jacques"
        },
        {
                "key": "lastname",
                "value": "Dupont"
        },
        {
                "key": "civility",
                "value": "MONSIEUR" // MONSIEUR ou MADAME
        },
        {
                "key": "email",
                "value": "test4814@calindasoftware.com" // pour tester, vous pouvez mettre votre adresse email ici
        },
        {
                "key": "cellPhone",
                "value": "0606060606" // pour tester, vous pouvez mettre votre numéro de téléphone ici
        }
    ]
},
    "contractors": [{
	"number" : "mycustomer65778", // le number de votre customer auquel le contractor est rattaché
	"mode" : 3,
	"id" : -1,
	"fields" : [{
		"key" : "firstname",
		"value" : "Jeanne"
	}, 
	{
		"key" : "lastname",
		"value" : "Martin"
	}, 
	{
		"key" : "civility",
		"value" : "MADAME"
	}, 
	{
		"key" : "email",
		"value" : "test24@calindasoftware.com"
	}
   ]
}],
    "contract": {
        "contract_definition_id": 2, // !!!ATTENTION!!! cet identifiant dépend de votre déploiement et vous est fourni avec votre document descriptif de votre API.
                                      // Il permet d'identifier le type de contrat qui est utilisé et d'y accrocher des comportements (par exemple les callbacks sur cloture d'un contrat)
        "pdf_file_path": "my_contract.pdf", // le nom du fichier pdf tel qu'il est donné dans le paquet http      
        "contract_id": -1,
        "message_title": "Votre contrat Z pour signature",
        "message_body": "Vous êtes signataire du contrat Z ci-joint pour la {{companyName}}. Merci de bien vouloir le signer électroniquement en cliquant sur le lien ci-dessous.<br>Cordialement,"		
    },
    "contract_properties": [
    {
        "key": "internal_contract_id", // une clé pour votre identifiant interne du contrat, la valeur pourra vous être donné lors du retour du fichier signé
        "value": "ma valeur", // la valeur de la clé
        "to_fill_by_user": 0
    }
    ],
    "files": [], // pour ajouter des annexes, exemple plus bas
    "options": [],

    "to_sign": 1 // Pour déclencher l'émission de l'email 
}

Réponse

{"customer_number":"test","contract_id":123456789,"contract_status":"OPEN"}

Ajouter des annexes au contrat

{
   ...
  "files": // annexes
  [
    {
      "path": "appendix.pdf",			
      "name": "appendix.pdf", 		
      "type": "application/pdf" 
    }
  ],
  "options": 
  [
    {
      "key":"hub.selling.contract.signparty.default.picture.option ou hub.selling.contract.default.picture.option",
      "value":""
    }
  ],
	
  ...
}

Affecter des rôles aux signataires

"rank" : 3

"role" : "nom du role"

"contractors": [{ "role" : "Directeur" 
... autres données du ou des signataire(s)...
 ]}

Utilisation de l'API en PHP

$response = $client->request('POST', 'https://cloud.sellandsign.com/calinda/hub/selling/do?m=sendCommandPacket', [
    'headers' => [
        'j_token' => $token
        ],

    'multipart' => [
        [
            'name'     => 'adhoc_light.sellsign',
            'contents' => fopen('C:\\xampp\htdocs\BridgeExample\\ressource/adhoc_light.sellsign', 'r'),
            'filename' => 'adhoc_light.sellsign',
            'headers'  => [
                'Content-type' => 'application/json'
            ]
        ],
        [
            'name'     => 'my_contract.pdf',
            'contents' => fopen('C:\\xampp\htdocs\BridgeExample\\ressource/my_contract.pdf', 'r'),
            'filename' => 'my_contract.pdf',
            'headers'  => [
                'Content-type' => 'application/pdf'
            ]
        ]
    ]
]);

Exemple de code PHP

Utilisation de l'API en Java

 HttpPost post = new HttpPost("https://cloud.sellandsign.com/calinda/hub/selling/do?m=sendCommandPacket"); // url du service
post.setHeader("j_token", "0025514|ccssccscqdcdxesdvdsd/6Gcj/23CEB16hmg=" ); // le token d'authentification

MultipartEntity mpe = new MultipartEntity();
    
// ajout du fichier .sellsign
String json_filename = "adhoc_light.sellsign";
InputStreamBody isb = new InputStreamBody( loadResource( json_filename ), "application/json", json_filename );
mpe.addPart( json_filename, isb);
    
// ajout du fichier .pdf
String pdf_filename = "my_contract.pdf"; // ce nom de fichier se retrouve dans le contenu json généré au dessus (voir le fichier adhoc_list.sellsign fournit en exemple)
isb = new InputStreamBody( loadResource( pdf_filename ), "application/pdf", pdf_filename );
mpe.addPart( pdf_filename, isb);

post.setEntity(mpe);
    
// Emission de la requête
HttpResponse response = client.execute(post);

Exemple de code Java

Utilisation de l'API en C#

Les erreurs retournées