OneSpan Sign Developer: Récupérer les paquets d'expéditeur
Dans ce blog, je vais vous guider à travers ce que vous pourriez avoir manqué dans la communauté OneSpan Sign Developer au cours de la semaine du 22 Juillet 2018. Aujourd'hui, nous couvrons les différences entre les propriétaires de comptes et les expéditeurs. Sans plus tarder, commençons.
Propriétaire de compte vs expéditeur
En tant que propriétaire de compte, OneSpan Sign vous offre la possibilité d'ajouter des expéditeurs à votre compte principal, ce qui leur permet de créer et d'envoyer des paquets de documents.
Il y a quelques différences entre un propriétaire de compte et un expéditeur :
- En tant que propriétaire de compte, dans l'interface utilisateur Web, lorsque vous cliquez sur la liste de retrait à côté de votre nom en haut de l'écran, vous verrez votre rôle en tant que "Manager". Les expéditeurs communs, cependant, seront par défaut au rôle de « membre ».
- Seul un propriétaire de compte a l'option "Admin" dans cette liste de retrait. Cependant, ce que nous allons discuter dans ce blog, c'est que seul un propriétaire de compte peut récupérer une clé API. Les expéditeurs ne peuvent pas obtenir directement les clés par l'intermédiaire de l'interface web. Cela signifie que les expéditeurs ne peuvent pas envoyer un appel API ou appeler les fonctions SDK eux-mêmes.
Comment récupérer les paquets et informations de l'expéditeur
En tant que propriétaire de compte, vous devez vous demander comment gérer les paquets, les modèles et les mises en page pour les expéditeurs, car ils ne peuvent pas récupérer leurs informations programmatiquement. Vous trouverez ci-dessous un guide étape par étape pour gérer ces éléments.
1. Récupérer la clé API de l'expéditeur
Pour récupérer ces informations, vous devez obtenir la clé API de votre expéditeur, et utiliser ce jeton pour appeler les API comme vous l'avez fait avec votre compte principal. Il y a deux étapes pour y parvenir :
Tout d'abord, vous récupéreriez l'ID de l'expéditeur (s) de deux façons. Ce qui suit saisira les 50 premiers expéditeurs de votre compte, que vous pourriez boucleà travers pour accéder aux ID de l'expéditeur:
GET https://sandbox.esignlive.com/api/account/senders?from=0&to=50.
Si vous n'êtes intéressé que par un seul expéditeur, vous pouvez effectuer une recherche directe pour cet expéditeur avec l'appel suivant :
GET https://sandbox.esignlive.com/api/account/senders?search-signerEmail
Ensuite, une fois que vous avez l'ID de l'expéditeur, vous pouvez utiliser l'API ci-dessous pour récupérer la clé API de l'expéditeur actuel. Même si nous mentionnons que les expéditeurs ne peuvent pas voir leurs clés API eux-mêmes, OneSpan Sign a une clé assignée à chaque expéditeur, et en tant que propriétaire de compte, vous êtes autorisé à les récupérer par:
GET https://sandbox.esignlive.com/api/account/senders/senderId/apiKey
Veuillez noter que cette fonction n'est actuellement disponible que par l'intermédiaire de l'API REST.
2. Liste de récupération des mises en page
GET /api/layouts?from 'fromLayout'to'toLayout
Autorisation : Clé api de base de votre expéditeur
3. Liste des iD de paquets
Vous pouvez utiliser l'appel API suivant pour récupérer directement les paquets d'un expéditeur spécifique. N'oubliez pas que cet appel API ne renvoie les paquets créés sous le propriétaire du compte principal que si vous utilisez la clé API d'un propriétaire. Au lieu de cela, vous devriez mettre la clé de l'expéditeur dans l'en-tête de demande.
GET /api/packages?query'status'from'fromPackage
Autorisation : Clé api de base de votre expéditeur
Vous pouvez également utiliser la fonction de rapport d'achèvement pour récupérer les ID de tous les expéditeurs. En utilisant cette stratégie, vous n'avez pas nécessairement besoin d'obtenir la clé API de l'expéditeur.
GET /api/reports/completion?status-status-from'fromDate
Autorisation : Clé de base du propriétaire du compte
Recherche de mots-clés
OneSpan Sign vous donne la possibilité de filtrer les résultats récupérés par mots clés. Vous pouvez simplement ajouter un paramètre « mot-clé de recherche » à votre appel API pour les trois scénarios suivants :
Pour les paquets de récupération :
GET /api/packages?search-keyword-de-l'album
Pour les modèles de récupération :
GET /api/packages?type 'TEMPLATE'search'mot-clé
Pour les mises en page de récupération :
GET /api/layouts?search-keyword-de-la-Page
remarquer:
1. Template est une sorte de paquet avec le type de "template"
2. Dans une URL, la valeur des paramètres de mot clé et de type (qui est modèle ici) n'est pas sensible au cas. Contrairement au paramètre d'état, qui indique l'état du paquet. Par exemple, "DRAFT" ou "SENT" doit être écrit en toutes lettres majuscules.
3. " De" et "à" dans les recherches ci-dessus sont des entiers correspondant à l'ordre du paquet/template/layout dans la liste des éléments.
Vous pouvez également utiliser les fonctions SDK avec des paramètres connexes pour atteindre le même objectif autre que celui de récupérer les touches API des expéditeurs.
Si vous avez des questions concernant ce blog ou toute autre chose concernant l’intégration de OneSpan Sign dans votre application, visitez les Forums communautairesdes développeurs .
