Help Guide

1. Account Registration

To begin using the API Portal, follow these steps:

Step 1: Sign Up

Navigate to the API Portal and fill out the registration form with the following details:

• First Name

• Last Name

• Email Address (Please use your official email address for registration)

• Password
  ⏳ Note: Password must be at least 8 characters long and contain at least 2 of the following: uppercase letters, lowercase letters, numbers, symbols.

• Captcha Verification

Step 2: Email Activation

• After submitting the form, an activation link will be sent to your registered email.

• Click the link to activate your account.
  ⏳ Note: The activation link is valid for 72 hours only.

Step 3: Confirmation

• Once activated, you will receive a confirmation email indicating successful account creation.

2. Lab Access & API Credentials

After account activation, you will receive:

Lab Access

• A dummy lab access code will be provided.

API Credentials

You will receive two separate emails:

• Email 1: Contains

  • Username

  • Subscription Key

  • Lab Code

  • Lab Name

• Email 2: Contains

  • API Password

3. Exploring APIs

Once logged in, you can begin exploring available APIs.

Step 1: Generate Token

• The first API to use is Token Generation.

• This token is required to authenticate further API requests.

Step 2: Available APIs

After generating the token, you can access the following APIs:

• Add TRF

• Update TRF

• Add Biopsy

• Add Supplement

• Fetch Test Results (based on TRF ID)

4. Sample Screen

The Sample screen provides examples of form and result data in various formats:

Form Samples

• XML

• JSON

• HL7

• PDF

Result Samples

• PDF

• FHIR

• HL7

  If you do not find what you are looking for, kindly contact helpdesk at Enterprise_Integration@coopersurgical.com