Guide to getting started with Postman

Screenshot of Postman

Postman is one example of the tools that you may use to connect to COS sandbox.

Regardless of the technology that you use, this guide may give you some hints about how to authenticate yourself and how to perform requests to COS sandbox.

You can find the following sections below:

  1. Before starting

  2. How to connect to COS sandbox

  3. Troubleshooting

1. Before starting

Preparations before using this guide

Before you start connecting to COS sandbox, using this guide, you need to have the following in place:

  1. Sign up and subscribe to the product Partner's API.
    This will provide you with:

    • Authentication credentials (Client-id and Client secret) to COS sandbox.
      The credentials are sent to you in an email.

    • API keys (Primary Key and Secondary Key).
      The API keys are displayed in your user profile.

  2. Install Postman on your computer.

2. How to connect to COS sandbox

Content in this section

This section provides the following:

  • a high-level overview of the workflow with the tasks you need to perform to connect and perform requests to the APIs

  • separate instructions for each task in the workflow

Workflow for connecting to COS sandbox

Below is a description of the tasks you need to perform in order to connect to the COS sandbox and then make two different requests: one request to a RestAPI and one request to a FHIR API.

See separate instructions for each stage below.

Create a collection for fetching access token

Follow the instruction below to create a new collection for the authentication, in order to fetch an access token.

Create new collection for sandbox requests

Follow the instruction below to set up a new collection for your sandbox requests.

Create a request for a REST API in COS sandbox

Follow the instruction below to create a request to a REST API in the COS sandbox. In this example we will use the API Chemistry lab results.

Generate a new access token

Follow the instruction below to generate a new access token if your previous token has expired.

Create a request for a FHIR profile in COS sandbox

Follow the instruction below to create a request for a FHIR profile in the COS sandbox. In this example we will use the Questionnaire resource.

3. Troubleshooting

Troubleshooting in COS sandbox

In the table below you can find descriptions of common issues and suggestions on how to remedy the problem.

For more information about error codes, see Error handling in COS.