Developer Onboarding

The BDS Developer portal is used by BDS Partners to securely integrate and share data with us. This article outlines the process to get onboarded with the Developer portal.

Steps

1. Developer Portal Registration and Approval
2. Login
3. Navigation

Developer Portal Authorization and Authentication

The Developer portal is accessible from the main menu at BDSSolutions.com

Access it by clicking the menu button   and Resources and clicking the Developer Portal link. 

Developer SignUp

The first step is to click the Sign Up  button  on the homepage menu of the Developer Portal.

The Sign up page opens. The partner fills in the required information to sign up.

Sign up fields:

1. Email
2. Password
3. Confirm Password
4. First Name
5. Last Name
6. Captcha

Vendor Authorization

The request for access is reviewed by IT and the corresponding Account Manager within 48 hours and access is approved/denied. The vendor receives an email when their request is approved. The approval email means the user can now login to the Developer Portal.

The credentials used to login to the developer portal are not the same as the credentials used to authenticate the API (see below).

Vendor Authentication Credentials

• After the vendor team member is authorized a separate email is sent to that user's registered email address with:
  • Vendor Username and Password - same credentials are used for both stage and production
    
  • Subscription Key - different keys for stage and production, both will be sent
    
    
• These credentials are specific to each vendor and are used by all developers accessing the API(s). 

For questions and support please email  FBSupport@bdsmktg.com.

Developer Portal Sign in and Navigation

Sign In

To Sign in to the Developer Portal click the SIGN IN link on the menu. Enter the email address and password created during registration.

The welcome screen is opened and the menu items are now accessible. 

Navigation

The developer portal uses a top menu to navigate through the site.

APIs

The APIs menu displays a list of the API names and descriptions accessible to the users profile. The API(s) accessible to the user is setup during the approval process.

Clicking an API name opens the API detail page.

• The left panel lists the API method and name
  
  
  
  
  
  
• The center panel provides a description of the API's details including Request URL, Request Parameters and Reponses.
  
  
• Clicking the Try It  button opens a panel enabling the user to test an API online before writing code to consume it.
  
  

Products

The products menu displays the Products accessible to the users profile. Products are groups of API(s) put together for specific partners ease of use and accessibility.

Reports

The reports menu provides statistics about usage on the portal.

Profile

This page enables the user to:

• Manage subscription keys - subscription keys are used in API request headers
• Change Password
• Close Account.