Getting Started

Follow these steps to make your first API call.

1. Install Postman

Postman is our preferred application to help you test out your endpoints. 

  • Navigate to this page and install the version of Postman appropriate for your operating system. 

2. Start Postman

  • Create a request and set the method to GET.
  • In the URL field, enter <Server>.com/<Tenant>/odata/$metadata. For example: https://v6pfsacademy.platformforscience.com/ODATA_TRAINING_SANDBOX/odata/$metadata
  • Set Authorization Type to Basic Auth. For information about authentication, see Authentication.
  • Enter the username and password.
  • Click Send to make your first API call.

3. Verify your data

$metadata - At the bottom half of the Postman application you can see the entity data model that you have within your whole system. Postman displays the different entity types in your instance of PFS as well as their attributes and the associations.

4. Make a Collection in Postman

  • Look for the  symbol in the Collections tab in Postman and create a collection to store all of your favorite calls from this tutorial.
  • When you finish making a call that you want to remember, clic Save to add them to that collection.

Now let's move on to making calls against general entity types.

5. Download the Postman Collection (QuickStart)

  • You can download a copy of some basic calls here.
  • Be aware that, to have a MY_ENTITY, your tenant requires some configuration. You can import that here.
  • Additionally, the Postman library was configured to use two environment variables, tenant and server, that you must create.