The Supplyframe App REST API provides an interface for integration applications to exchange information with Supplyframe.

Once you have retrieved your credentials, you will use the Supplyframe App API Reference Guide for all additional information regarding the API within your application.

Prerequisites to getting started

  • Your DSI account has been created by Supplyframe
  • Within your DSI account, API has been enabled by Supplyframe
  • Your user account has been given the special designation of Owner by Supplyframe

API Setup Process

  1. Log in to your DSI account.
  2. Navigate to the System Settings page from your Profile dropdown.
  3. Then click on Supplyframe API from the left menu bar.

Fullscreen_4_5_24__8_10 PM.jpg

    4. On the API page, enter the appropriate member's email address and password. Then click on the “Submit” button. These credentials will be used for the API service. The API user email can be a separate user from the account owner.

Cursor_and_Window_and_System_Settings___Api___Supplyframe_DSI.jpg

API Maintenance

1. Reset Password

a. Click on the “Reset Password” icon to the far right of the API User's email.

Cursor_and_Window_and_System_Settings___Api___Supplyframe_DSI.jpg

b. Enter the Current Password, New Password, and Confirm the New Password. Then click Save.

Window_and_System_Settings___Api___Supplyframe_DSI.jpg

2. Change API User

a. Click on the “Delete” icon to the far right of the API User's email.

Cursor_and_Window_and_System_Settings___Api___Supplyframe_DSI.jpg

b. In the modal window, it will ask to confirm: "Are you sure you want to delete this API credential?" Click on Delete to confirm and remove the email, or on Cancel to disregard.

Window_and_System_Settings___Api___Supplyframe_DSI.jpg

c. This will remove the API user and return you to the “Create API User” form page.