Getting Started

Learn how to set up your integration with the Printeers API.

Prerequisites

Before you begin, you need:

• A Printeers partner account. Create an account if you don't have one.
• A V2 API secret key, generated in the Printeers Dashboard under API Settings.

Environments

Printeers provides two environments:

Always develop and test your integration against the test environment first.

Authentication

All API requests require authentication via the X-Printeers-Secret-Key header:

X-Printeers-Secret-Key: YOUR_SECRET_KEY

Keep your secret key secure and never expose it in client-side code.

Making Your First Request

Validate your credentials by calling the auth endpoint:

curl -i -X POST https://api.test-printeers.com/v2/auth/validate \
  -H "X-Printeers-Secret-Key: YOUR_SECRET_KEY"

A successful response confirms your credentials are valid:

{
  "message": "Authentication is valid"
}

If authentication fails, you'll receive a 401 Unauthorized response with an error message.

Exploring the API

Once authenticated, you can explore available resources:

• Catalog: GET /products and GET /packagings to browse available products and packagings.
• Renders: POST /renders to create product mockups.
• Orders: GET /orders/{orderReference} to retrieve order details.
• Shipments: GET /shipments/{shipmentReference} for tracking information. See the Shipments and Tracking guide.

See the API Reference for complete endpoint documentation.

Error Handling

The API uses standard HTTP status codes:

Error responses include a JSON body with details:

{
  "code": "invalid_request",
  "message": "Description of what went wrong"
}

Next Steps

• Read the Organization Structure guide to understand accounts, stores, and brands.
• Browse the API Reference for detailed endpoint documentation.
• Read the API Versioning guide to understand our release cycle.
• Learn how to paginate through large result sets.