Secure Exchanges SDK - Documentation
Bienvenue dans la documentation officielle du Secure Exchanges SDK.
Qu'est-ce que Secure Exchanges SDK ?
Secure Exchanges SDK est une bibliotheque .NET complete pour l'echange securise de messages, le chiffrement de fichiers et les signatures electroniques. Elle vous permet de :
- Envoyer des messages chiffres par email ou SMS
- Transferer des fichiers jusqu'a 2.5 Go avec chiffrement de bout en bout
- Signer des documents PDF electroniquement
- Suivre la livraison et l'ouverture des messages
- Integrer des communications securisees dans vos applications
Composants du SDK
SecureExchangesSDK (Principal)
Le SDK principal offre toutes les fonctionnalites de base :
| Classe | Description |
|---|---|
MessageHelper |
Envoi et recuperation de messages |
CryptoHelper |
Operations de chiffrement/dechiffrement |
SignHelper |
Operations de signature numerique |
LicenceHelper |
Gestion des licences |
LogsHelper |
Journalisation et audit |
MessengingHelper |
Workflows SESAR |
SecureExchangesSignatureSDK
SDK complementaire pour la certification PDF avancee avec PKI :
| Classe | Description |
|---|---|
PkiFileHelper |
Moteur de certification PDF |
CertifyPdfArgs |
Parametres de certification |
ZoneDetails |
Definitions des zones de signature |
Demarrage rapide
1. Installation
Choisissez le package qui correspond à votre framework cible :
| Framework cible | SDK principal | SDK Signature (optionnel) |
|---|---|---|
| .NET Framework 4.7.2+ (Windows uniquement) | SecureExchanges |
SecureExchanges.Signature |
| .NET 8+ (Windows + Linux) | SecureExchanges.NetCore |
SecureExchanges.Signature.NetCore |
# .NET Framework — SDK principal
Install-Package SecureExchanges
# .NET 8+ / .NET Core — SDK principal
Install-Package SecureExchanges.NetCore
Note
La variante .NetCore est requise pour un déploiement sur Linux (par exemple Azure Functions en container Linux).
Voir Certification PDF et Déploiement Azure Functions.
2. Configuration minimale
// Vos identifiants API (obtenus via le portail Secure Exchanges)
Guid serial = new Guid("VOTRE-SERIAL");
Guid apiUser = new Guid("VOTRE-API-USER");
Guid apiPassword = new Guid("VOTRE-API-PASSWORD");
Uri endpoint = new Uri("https://www.secure-exchanges.com/_api/0217/0217.asmx");
3. Premier message
using SecureExchangesSDK.Helpers;
using SecureExchangesSDK.Models.Args;
using SecureExchangesSDK.Models.Entity;
// Creer la liste des destinataires
var recipients = new List<RecipientInfo>
{
new RecipientInfo { Email = "destinataire@example.com" }
};
// Configurer les arguments
var args = new MutliRecipientArgs(
endpoint, serial, apiUser, apiPassword,
recipients,
message: "Votre message securise",
subject: "Sujet du message",
password: null,
filesList: null,
SendMethodEnum.onlyEmail,
sendByMyOwnSMTPServer: false,
showSubject: true,
getNotify: true,
culture: "fr-CA",
maxOpeningTime: 5,
expirationMinutes: 1440 // 24 heures
);
// Envoyer le message
var response = MessageHelper.MultiRecipientMessage(args);
if (response.Status == 200)
{
Console.WriteLine("Message envoye avec succes!");
Console.WriteLine($"URL: {response.RecipientsAnswer[0].Answer.URL}");
}
Prerequis
- .NET Framework 4.7.2+ (pour
SecureExchanges/SecureExchanges.Signature) ou .NET 8.0+ (pourSecureExchanges.NetCore/SecureExchanges.Signature.NetCore) - Licence Secure Exchanges valide
- Identifiants API (Serial, API User, API Password)
Obtenir vos identifiants API
- Connectez-vous au portail Secure Exchanges
- Allez dans Compte > Options > Gestion des utilisateurs
- Selectionnez un utilisateur avec licence API
- Cliquez sur l'icone "Cle API" pour generer vos identifiants
- Un message securise contenant vos cles sera envoye a l'adresse associee
Warning
Le message contenant vos cles expire apres 15 minutes. Gardez vos identifiants en lieu sur.
Structure de la documentation
| Section | Description |
|---|---|
| Guide de demarrage | Installation et configuration detaillee |
| Architecture | Concepts et architecture du SDK |
| Envoi de messages | Tutoriels d'envoi de messages |
| Chiffrement | Operations de chiffrement |
| Signatures | Signatures electroniques PDF |
| SESAR | Workflows de messagerie avancee |
| Codes de statut | Reference des codes d'erreur |
| Bonnes pratiques | Recommandations de securite |
Support
- Email : support@secure-exchanges.com
- Site web : https://www.secure-exchanges.com
- NuGet : https://www.nuget.org/packages/SecureExchanges/