Pairtree Pipes Sandbox How-To Guide
Below you will find some key guides to get you started with the Pairtree Pipes Sandbox.
We highly recommend using the Postman pack as it handles 95% of the setup for you. However, if you prefer a DIY approach, our documentation provides everything you need.
We love feedback, so if there are any features you’d like to see in the Sandbox, improvements to our how-to guide or to Pipes overall, please don’t hesitate to let us know through our contact form.
To gain access to our Sandbox, please complete the registration form here and click Register.
Ensure that you provide a valid email address as this will be used for account verification and for sending your API key.
We only allow one registration per company, but if your team would like to explore more functionality please get in touch with us to discuss options.
One you have registered for an account, the next step is to verify your email address.
You’ll receive an email from “noreply@pairtree.co” containing a verification link.
Simply click the link where it says “click here” and your account will be verified, which will also send you a welcome email and API Key.
If you don’t receive the verification email, or require another one, you can request to resend it here.
Once you have verified your account, you’ll receive a welcome email that includes your API key and a link to the API documentation.
Keep your API key handy as you will need it to use the Sandbox and all of the functions.
If you haven’t received the verification email, or need another one, you can request to resend it here.
If you have lost the email that contains your API key, please reach out to us via our contact form to have it resent.
We have prepared a suite of Swagger/OpenAPI 3.0 compatible documentation which you can find here.
The documentation outlines all the API functions, their corresponding endpoints, as well as the available and required parameters.
Please note the documentation is subject to updates. We recommend you bookmark the page to ensure you always refer to the most current version, rather than downloading a static copy.
For all the Postman fans out there, we’ve created a convenient Sandbox pack to download that you can easily import into Postman and start using immediately.
To get started, simply download the Sandbox API Documentation.
Once downloaded, insert your API key into the ‘apikey-piper’ variable, and you’re all set to start exploring.
Quick Setup Guide
Download the API Documentation here.
Open your Postman workspace and import the ‘openapi.json’ file as a collection.
All of the functions in this collection require the API key from your welcome email. Assign this key to the header variable ‘apikey-piper’ in the request. Remember, this key is unique to each account and should not be shared.
Once you have configured the Postman collection, you will need to execute the “Organisation List” function to get your client API keys.
To get client API Keys in Postman
Open Postman and ensure that you have imported and configured the collection.
Locate the “Organisation List” function, and then execute this function by clicking on the corresponding request.
Upon successful execution, you will receive a response containing the organisation information and the client API keys. Once you have the client API keys, you can use them to access the corresponding Sandbox organisations.
Each Sandbox account is provided with two client keys, one for “Notalotta Acres” and another for “A Few More Acres”.
To proceed, you’ll need to insert one of the client API Keys into the ‘apikey-org’ header variable for your requests.
Related Links
Sandbox API Documentation
Looking for Sandbox API Documentation?
You can access the documentation at the below link – be sure to bookmark it as it may change from time to time!