Welcome to the Youforce API Postman Collection, designed to help you seamlessly integrate with our platform and access the sandbox environment. Follow these steps to begin your integration journey:

Copy the API Collection

Take a copy (fork) of the postman collection you want to use. This will provide you with a ready-to-use set of API calls, complete with request parameters and examples. With the next steps you can create a fork:

  1. Access Postman: Start by opening Postman and make sure you’re logged in with your Postman account.
  2. Locate the Collection: Navigate to the Youforce API Postman Collection you want to fork. In your case, it’s the Youforce API Collection
  3. Fork the Collection:
    • Click on the collection you want to use.
    • In the top-right corner, you’ll see a “Fork” button. Click on it.
    • Postman will create a copy of the collection in your own workspace. You now have your own version of the collection that you can modify without affecting the original.

Copy the Environment Settings for the sandbox environment

For the sandbox environment we have configured all relevant setting. To use this sendbox tenant, you can take copy (fork) of our Sandbox Environment Settings

Keep Your Collection Updated

As we continually improve our API, we recommend frequently pulling updates from the main collection. This way, you’ll stay up-to-date with the latest features and enhancements. You can update the collections and envrinment setting with the following steps:

  • Click on your forked collection in Postman to open it.
  • Click on the 3-dots (…) behind the collection you want to update. A sub-menu will appears
  • Select Pull changes from the menu.
  • Postman will compare the changes and show you a list of what’s different.
  • Review the changes and click on Pull changes to bring those changes into your forked collection

Access the Sandbox Environment

Once you have the collection and environment settings, you can start making API calls to our sandbox environment for testing and development purposes.

Useful Links