Postman sample OData queries

Overview

Postman is a tool that lets you construct, execute, and test HTTP requests in a quick and easy way. This article, demonstrates how to run OData queries with the Postman app against a real environment. Postman provides a sandbox to play with different sample queries and see the results. 

For more information, see OData Getting Started.

PREREQUISITES: You need to connect to an online Sitefinity CMS instance.
You need to:
  • Host your Sitefinity CMS instance on IIS. 
    For more information, see Run projects on IIS.
  • Setup authentication.
    For more information, see Request access token.

Configure Postman

To run the tutorial, perform the following:

  1. Install The Postman app or use Postman on the web.
    To do this, go to Download Postman.   
  2. Sign in or register in Postman and open it.
  3. Import the SitefinityODataPostmanCollection.json file.
    This file contains all sample queries described in the Headless API documentation. 
  4. In Postman, in the left menu, click Environments » Import.
  5. Upload the SitefinityODataPostmanEnvironment.json file and import it.
    The Postman environment defines multiple variables that you must configure to be able to use the provided samples. 
    For more information, see the Postman documentation » Using variables.
  6. Select Sitefinity Web Services environment and edit it.
  7. Assign you current Sitefinity CMS instance URL to the baseurl variable
  8. Change the values of username and password, if required.
  9. In the left, click Collections » Sitefinity Web Services.
  10. Click the Auth tab and select the type of authentication, corresponding to the authentication protocol of your Sitefinity CMS instance.
  11. Execute the request. 
    If the request is successful, the token received will be automatically added to the environment variables

RESULT: You are set up. You can start executing other request and playing with the samples. 

Want to learn more?

Sign up for our free beginner training. Boost your credentials through advanced courses and certification.
Register for Sitefinity training and certification.

Was this article helpful?

Next article

Headless API reference