Équipe et administration
Points de terminaison API
Laissez des programmes, scripts et automatisations envoyer des documents à une URL secrète et les imprimer.
Un point de terminaison API est une URL secrète à laquelle des programmes envoient des documents, par exemple des factures d’un ERP, des étiquettes d’une boutique en ligne ou des rapports d’un script. Chaque document devient une tâche au nom de la personne qui a créé le point de terminaison et va à sa destination. L’URL elle-même est la clé d’accès, aucun jeton d’API n’est nécessaire. La référence de l’API décrit chaque option.
Prérequis
- Le canal d’entrée REST API doit être activé sous Paramètres → Canaux d’entrée. Il est activé dans les nouvelles organisations ; dans les plus anciennes, un administrateur doit peut-être l’activer.
- Chaque membre peut créer des points de terminaison API. Les utilisateurs voient les leurs, les administrateurs tous ceux de l’organisation.
- Inclus dans toutes les offres.
Configuration initiale
- Allez dans Sources → Points de terminaison API et sélectionnez Nouveau point de terminaison API.
- Saisissez un Nom qui indique à quoi sert le point de terminaison, par exemple « Factures de l’ERP ».
- Choisissez la Cible des documents dont la requête n’en indique aucune : une destination, un groupe ou un flux de travail, la Cible par défaut du propriétaire, ou Aucune cible – garder dans Sealed Print.
- Sélectionnez Créer et copiez l’URL du point de terminaison dans votre programme.
Envoyez le document comme corps de la requête avec le Content-Type correspondant :
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
-H "Content-Type: application/pdf" \
--data-binary @invoice.pdf
Ou comme formulaire avec le champ file ; les options sont des champs du formulaire :
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
-F "file=@invoice.pdf" \
-F "name=Invoice" \
-F "copies=2"
targets envoie une requête ailleurs par identifiant : les identifiants de destinations, de groupes ou d’un flux de
travail, séparés par des virgules, par exemple targets=office,warehouse (un flux de travail vient en premier).
destinationId, destinationIds, groupId ou workflowId font de même par ID, et noTarget=true (ou
targets=hold) garde le document dans Sealed Print. Ils remplacent la cible du point de terminaison pour une requête ;
les options d’impression comme copies ou sides sont des paramètres de requête ou des champs du formulaire. La
réponse est la tâche (HTTP 201).
À chaque fois
- Dernière utilisation sur le point de terminaison indique si un programme envoie encore des documents.
- Modifier change le nom et la cible ; l’URL reste la même.
- Générer une nouvelle URL remplace l’URL ; l’ancienne cesse aussitôt de fonctionner. Supprimer met fin au point de terminaison définitivement.
- Pour suivre le statut d’une tâche depuis votre programme, utilisez un jeton d’API.
Dépannage
- HTTP 403 : le canal d’entrée REST API est désactivé, ou la personne qui a créé le point de terminaison a quitté l’organisation. Créez un nouveau point de terminaison avec un autre membre.
- HTTP 404 : l’URL est erronée ou a été remplacée par une nouvelle. Avec le code
unknown_target, un identifiant detargetsn’existe pas ou appartient à une destination vers laquelle le propriétaire du point de terminaison ne peut pas imprimer. - HTTP 413 ou 415 : le fichier dépasse ce que l’offre permet, ou n’est pas un PDF, JPEG ou PNG.
- L’URL a été copiée là où elle ne devait pas l’être : sélectionnez aussitôt Générer une nouvelle URL.
Et ensuite
- Référence de l’API : chaque point de terminaison, avec la description OpenAPI.
- Jetons d’API
- Canaux d’entrée et de sortie
- Imprimer les documents Stripe : factures, avoirs et devis de Stripe via un point de terminaison API.