Développez avec l'API PrintKK
Commencez par l'authentification par signature, puis implémentez le téléchargement d'images, la création de designs, la création de commandes et le paiement via des points de terminaison REST.
Fonctionnalités principales de l'API
Concentrez-vous sur le flux de production essentiel, des assets au paiement, basé sur les groupes de points de terminaison documentés.
Signature et authentification
Utilisez les spécifications de signature et d'authentification pour sécuriser chaque requête et contrôler l'accès à vos opérations API.
Télécharger des images
Téléchargez des assets de design via les points de terminaison d'images et préparez les fichiers pour la génération de designs en aval.
Créer des designs
Créez des données de design avec les points de terminaison de design et organisez les paramètres requis pour une sortie prête pour la production.
Créer et payer des commandes
Soumettez des payloads de commande et effectuez les paiements via les points de terminaison de commande pour clôturer le flux de transaction.
Flux d'intégration API
Du premier appel authentifié à la commande payée, ce parcours en quatre étapes reflète la façon dont nos API sont regroupées dans la documentation : accès sécurisé, assets image, designs imprimables, puis checkout et paiement. Traitez chaque étape comme un point de contrôle afin que votre backend reste prévisible et facile à déboguer.
Configurer la signature et l'authentification
Lisez les chapitres sur la signature et l'authentification, émettez ou importez les identifiants nécessaires à votre environnement et implémentez la signature exactement comme spécifié. Envoyez quelques requêtes de test à faible risque et confirmez que vous recevez des réponses réussies avant de procéder aux téléchargements -- lorsque l'authentification est solide, les erreurs ultérieures pointent presque toujours vers la structure du payload plutôt que vers des 401 mystérieux.
Télécharger les images nécessaires à vos produits
Utilisez les points de terminaison d'images pour télécharger des logos, des œuvres d'art ou d'autres fichiers requis par votre intégration. Stockez chaque identifiant renvoyé dans la réponse API afin de pouvoir transmettre ces valeurs dans les requêtes de design suivantes, conformément aux exemples de requêtes.
Créer et persister les enregistrements de design
Appelez les points de terminaison de design pour créer des enregistrements de design qui combinent produits, emplacements et références d'images de l'étape précédente. Conservez les identifiants de design renvoyés dans votre système afin que les payloads de commande puissent y faire référence, comme décrit dans la section Commande de la documentation.
Soumettre la commande et finaliser le paiement
Soumettez les commandes via les points de terminaison de commande en utilisant les identifiants de design stockés. Finalisez le paiement en suivant les étapes documentées pour les points de terminaison liés au paiement. Les réponses, codes de statut et corps d'erreur dans la documentation font autorité -- ne vous fiez pas à un comportement qui n'y est pas décrit.
Au-delà du parcours d'intégration principal
La documentation API officielle regroupe également Produit, Général, FAQ et Changelog aux côtés de Authentification, Image, Design et Commande. Utilisez ces sections lorsque vous avez besoin de données de catalogue, d'utilitaires partagés ou d'historique des versions que le flux principal ne couvre pas seul.
-
Produit
Les points de terminaison Produit décrivent comment interroger les articles du catalogue, les variantes et les options qui s'associent aux designs et aux commandes. Consultez-les lorsque vous devez résoudre les ID produit ou les attributs avant de construire un payload.
-
Général
La section Général couvre les utilitaires et les requêtes transversales qui accompagnent les appels d'image, de design et de commande. Vérifiez la référence lorsque vous avez besoin d'opérations d'aide documentées là-bas.
-
FAQ et Changelog
Consultez la FAQ pour les questions d'intégration courantes et utilisez le Changelog pour suivre les mises à jour API, les ajouts et tous les changements incompatibles au fil du temps.
Cas d'utilisation API courants
Modèles d'implémentation typiques basés sur les capacités d'image, de design et de commande.
Pipeline de design automatisé
Téléchargez des images par lots et générez des designs par programmation pour accélérer la production de contenu.
Service de soumission de commandes
Construisez un service backend qui convertit les données de checkout en requêtes de commande standardisées.
Workflow de finalisation de paiement
Connectez les points de terminaison de création de commande et de paiement en une séquence de transaction contrôlée avec une gestion claire des statuts.
Ressources pour les équipes
Utilisez la documentation et les canaux de support pour accélérer le développement et le déploiement.
Documentation développeur
Consultez les groupes de points de terminaison, les détails d'authentification et des exemples de payload pour les opérations d'image, de design et de commande.
Ouvrir la documentationSupport technique
Contactez l'équipe PrintKK pour les questions d'implémentation et le dépannage d'intégration.
FAQ API
Que devons-nous implémenter en premier ?
Commencez par la signature et l'authentification afin que chaque requête d'image, de design et de commande suivante soit vérifiable et sécurisée.
Quelles opérations principales sont prises en charge ?
Les opérations principales documentées sont le téléchargement d'images, la création de designs, la création de commandes et le paiement des commandes.
Comment devons-nous structurer la séquence d'appels ?
Utilisez un flux linéaire : authentifier les requêtes, télécharger les images, créer les designs, créer les commandes, puis finaliser le paiement.
Où pouvons-nous trouver les détails des requêtes ?
Consultez la documentation API pour les paramètres des points de terminaison, des exemples de requêtes et des notes d'implémentation spécifiques à chaque section.
Commencez l'intégration dès aujourd'hui
Ouvrez la documentation API pour consulter les règles de signature, les paramètres des points de terminaison et des exemples de requêtes pour chaque fonctionnalité.
