Printfection API Documentation
The following documentation is available to assist you in learning and developing with the Printfection Platform
You can download each file below, or download all documentation in a single zip archive.
Platform Documentation Zip (1.8mb)
Platform Overview
This document gives a brief overview of the various features of the Printfection Platform & API and is a good starting point for all developers new to the platform. After reading this document we suggest you read the Getting Started Guide.
Getting Started
This guide covers the following topics:
- Requesting and setting up your application on Printfection's website
- User authentication
- Verifying your application can access the Printfection API after it has been authenticated to an account
- High level walkthrough explaining how to upload an image, change an image’s name, create a product, etc.
- An overview of the checkout process
Authentication
This guide covers the authentication methods used by the Printfection Platform as well as the methods to authorize your application.
Permissions
This guide covers the available permissions and how to work with users of your application.
Methods
Methods are used by an application to either get information about objects or manipulate objects such as products, images, etc. via the API. Methods allow an application to create objects, delete objects, make changes and get information back about objects. The current set of methods focus on images, products, stores and sections.
This document contains technical details about every method available through the Printfection API. It contains information about the permissions required to run each method, the possible parameters, and example responses.
Printfection Query Language
This document cover PFQL which provides a uniform and flexible way to get nearly every piece of information available through the API. Currently the only exception is product pricing which require the use of specific methods. PFQL uses SQL style syntax to request information.
Printfection Query Language (PFQL) PDF
Application Quotas
Quotas manage the use of the API to ensure an application doesn’t overload our system. This document describes how best to balance your application.
Image URLs
This document explains the image URL conventios used at Printfection and how to access them using the API.
Errors
This document lists the error codes and explains the reasons that these might occur when using the API.
Storable Information
As described in the Developers Terms of Service, you may not cache any user or Printfection data for more than 24 hours except the information described in this document. All other information must be requested from Printfection each time.
Dates
Currently dates can only be pulled from the API and cannot be set. All dates will be returned in the Unix timestamp format.
Checkout
Printfection Platform Checkout allows the application to leverage Printfection’s investment in the most complex and expensive elements of a successful e‐commerce system credit card processing, PCI/security compliance, and order fulfillment while keeping the user within the application until the final stages of checkout.