Getting started
Get started by creating a new account on RPI Print API.
Visit https://api.rpiprint.com and create a new account with RPI Print. Your account will be associated with a customer and given a public customer Id.
Getting your bearings
Use the following steps to create your first product and understand the system at a high level.
- Ensure your admin console is in Sandbox mode (explained below). It is selected by default for new users.
- Navigate to the Products and create a product. Products map an identifier called a SKU to the physical characteristics of what we produce.
- Navigate to the API Credentials under Developer Tools. This is where you can access your credentials to place orders.
- Navigate to the API Examples under Developer Tools. Place a test order using the /orders/create endpoint and the API credential and products from the previous steps. Take note of the post data as this endpoint is how you will submit orders from your system.
You now know how to create products and place orders. You can begin building your integration.
Please note that if you place production orders, they will not proceed beyond the "Awaiting Payment" state until you add a credit card in the admin console and it is successfully charged.
Webhooks
Including a webhook in the order submission POST data enables you to receive order updates.
Webhooks are registered per-order internally. If you need to include an order identifier in your webhook url or use different webhook endpoints for sandbox and production, you can do so.
For full information on webhooks, including a table of possible webhook events, click here
Sandbox and Production modes (admin console)
The Sandbox mode allows you to test your integration by placing and interacting with sandbox orders. Sandbox orders will not charge your credit card and will not be printed.
You can switch between sandbox and production using the sandbox toggle banner at the top of the page. The banner will always show you what mode you are in.
The orders and API credentials presented by the admin console are each filtered according to mode. So if you are in sandbox mode you will only see sandbox orders and sandbox credentials.
You can test payment callback webhooks for sandbox orders with the "Test Order Payments" button above the orders table in sandbox mode.
Your products are shared between sandbox and production, so once you are satisfied with testing you can use your product configuration immediately in production.