Guide for ISV Partners: Transitioning from DNA Behavior Version 1 to Version 2

A comprehensive guide for ISV Partners on smoothly transition their apps from DNA Behavior Version 1 to the upgraded Version 2.

We appreciate your ongoing partnership and collaboration as we continue to enhance and improve our DNA Behavior systems. Over the past two years, we have been diligently working on upgrading our systems, resulting in the launch of DNA Behavior Version 2, which happened earlier this year. This new version brings a host of benefits, including improved performance, scalability, enhanced security features, and a modern tech stack.

We understand that transitioning from Version 1 to Version 2 might bring about some changes in your integration processes. We've been communicating these changes since January 2022, and we want to ensure a smooth transition for you. In this article, we will provide you with detailed instructions on the impacts of shifting to Version 2 and how to adapt your app accordingly.

Since January 2022, we've been communicating about the shift to DNA Behavior Version 2. Please note that all partners must transition from Version 1 (dnabehavior.biz domains) by September 7, 2023.

Please know: Our support team is here to assist you as you require assistance. Create a ticket here: Click here. 

Important Changes and Instructions:

Base URL Change for Production and Sandbox are changing:

To streamline and modernize our app, all of our builds are now available on the dnabehavior.com domain (with various subdomains). Please make note of the new base URL:

New Base URL:

  • Prod: https://api.dnabehavior.com/ 
  • Sandbox (See note below): https://api.dnabehavior.com/

Note: Sandbox access in 2023 will be on the same base URL as Prod. We are adding SSO and Social login in late 2023, at which time we will be re-issuing sandbox credentials on our sandbox build. 

Authentication Method Update:

To enhance security, we are transitioning to a more secure system of API keys for authentication. You will now be responsible for managing your API keys. Follow these steps to create an account, gain developer access, and obtain your API keys:

Article: ISV Developer Portal and Accessing the DNA API

Article: Accessing the DNA API Keys

Submit Answers API: Updated Sequence of Events for Submit Answers API

A change in the sequence of events for the Submit Answers API has been implemented. Instead of you assigning the Person ID, our system will now handle this. The Person ID will be assigned once a 200 success response is received. Please adjust your integration process accordingly to accommodate this change.

Get Hiring API: New Hiring Roles and IDs

In March 2022, we provided each team that was using the Hiring API with new Hiring Roles and IDs. Please refer to the attached document for this information. If you require any further assistance regarding these roles and IDs, do not hesitate to reach out to our support team.

 

Roles - V1 API

New Roles - V2 API

Change in Name?

45

Administrator/ accountant

Administrator

Yes

48

Analyst

Analyst

No

51

Coach

Coach

No

44

Community networker

Community networker

No

56

Compliance

Compliance

No

58

Creative design

Designer

Yes

55

Event manager

Event Planner

Yes

46

Finance director/ manager

Finance director/ manager

No

42

Inside sales

Inside Sales

Yes

53

Operations manager

Operations Manager

Yes

41

Outside sales

Outside Sales

Yes

57

Product development

Product Developer

Yes

54

Project manager

Project Manager

Yes

60

Quality control

Compliance and Quality Control

Yes

52

Recruiting

Recruiter

Yes

59

Relationship manager

Relationship manager

No

49

Researcher

Researcher

No

43

Sales support

Sales support

No

47

Strategic planning

Strategic planning

No

50

Trainer

Trainer/Teacher

Yes

       
 

Newly added roles will be assigned IDs

 

61

N/A

Sales Manager

N/A

63

N/A

Engineer

N/A

66

N/A

Accountant

N/A

67

N/A

Technician

N/A

72

N/A

Author

N/A

69

N/A

Counsellor

N/A

71

N/A

Enforcement and Protection

N/A

83

N/A

Operations Support

N/A

65

N/A

Marketing & Communications

N/A

62

N/A

Customer Support

N/A

64

N/A

Business Promotion

N/A

Migration from Version 1 to Version 2: 

Once you have prepared for the above steps, our team will migrate your records from the Version 1 to Version 2 account. You can prepare for the migration with the following article: Know before you go. The migration will impact you in the following ways: 

  • You will be assigned a new Account ID (integer signifying your account)
  • Each participant (end user that has completed an assessment) will be issued a new Person ID. The new Person ID that is assigned to them is available via export in the DNA Web App.  As the Person ID's are required to make Get calls for legacy individuals, it will be important for you to update this in your system, should you wish to make Get calls for participants that have completed assessments historically. 

Note for matching records in Version 1 to Version 2: Both the Version 1 and Version 2 systems have email addresses as the username and Person ID in the form of GUIDs. We recommend matching up these records in this way. If you require assistance or need help with the exports, our team is here to help. 

Frequently Asked Questions:

  • If we cannot migrate by the September 7 deadline, what options do we have? 
    • After the cutoff deadline, your client data will be migrated and available in the DNA Web app (app.dnabehavior.com).
    • You will be provided with access to the Professional Package for participant and dashboard access.
    • You will continue to have access to the client data generated in Version 1 and all of the features and functions of the web app, you just will not be able to use the DNA API features until the above steps have been completed.
  • Are the Version 1 Participant Reports available in Version 2 DNA API?
    • No, as announced in January 2022, there are no Version 1 reports available via the API in Version 2. 
  • Are the Version 2 Participant Reports available in the DNA API? 
    • No, as the Partner agreement stipulates, the ISV focus is on building different experiences which are unique to the PDF reports that DNA Behavior offers.