Supplier API Integration Testing Guide

Testing the APIs is a critical step before enabling them in production. Some APIs, like the Job Requisition APIs, can be used directly in production since they are simple GET requests. However, for use cases such as submitting candidates, it is strongly recommended to use a sandbox environment to verify functionality and data flow.

Step-by-Step Guide to Test in a Sandbox Environment

1. Test Environments

You will need access to two environments:

  • Beeline Supplier Network (BSN): Where the APIs are exposed.

  • Beeline Enterprise (BE): The client environment used to create Job Requests, which will flow through the BSN APIs.

2. Request Access via Jira Service Management (JSM)

To get started, request access to both the BSN and BE sandbox environments:

  1. Click here to go to the Jira Service Management portal. You will have to create a free account to access the portal.

  2. You can use this message in your ticket: "I need to test the Supplier API."

Once your request is processed, you will receive access to two environments:

  1. Beeline Supplier Network (BSN)
    You will receive an email invitation to join BSN as an Admin with full access.

  2. Beeline Enterprise (BE) Sandbox
    You will receive a separate email with details about your BE sandbox environment, including:

    1. A new supplier organization and user created for testing

    2. Credentials to access the sandbox as an MSP user (you will need this for step 5)

3. Activating the Supplier User Account

  1. Go to the login page of the BE sandbox and enter the supplier user account email.

  2. Use the "Reset Password" link in the login page, and set a new password.

4. Link the BSN and BE Accounts

Login to the BSN sandbox.

  1. From your BSN account, click Clients (in the left navigation menu)

  2. Click the "Link" button in the top-right corner

  3. Enter this BE project site URL: https://projects.beeline.com/proj301 and click "Link"

  4. A new tab will open with the BE project site login page

  5. Log in using your BE sandbox supplier account credentials

  6. Confirm the account linking request when prompted after logging in

  7. Go back to your BSN tab, refresh the browser, and verify that the connection shows "Connected" (this may take a few minutes)

5. Begin Testing the API

Once your BSN account is linked to your BE test account, log out of your BE supplier account and login as an MSP user:

  • You can create Job Requests from BE as an MSP user

  • These requests will flow to BSN and can be verified via the API

How to Set Up Data in BE for Testing

Login to the BE sandbox as an MSP user and follow the steps below:

Following these steps ensures your API integration is properly validated in a controlled test environment before going live.