Skip to content
Developer

Onboarding Checklist

Onboarding Checklist

High Level End-to-end (E2E) Testing

  1. Get credentials.
  2. Retrieve an opportunity live link successfully from the opportunity registry.
  3. Send a respondent in to the live link.
  4. Choose a disposition.
  5. Retrieve them back through the redirect URL, and interpret it appropriately.

Successfully completing this test will indicate the following:

  • Valid credentials.
  • Correct signatures.
  • Access to the Opportunity Registry
  • You can successfully send a respondent into the redirect URL.
  • You get a disposition and are redirected out to the partner’s platform.

Server-to-server (S2S) testing (Optional)

Dynata cannot verify a parters S2S logging data, as this will be saved on the partner side.

  • Follow the same steps as the E2E test.
  • If you have an S2S URL configured, verify that the information desired is being written out to your logs and can be accessed successfully.

Opportunity Registry Testing

Receive opportunity notifications.

Make sure you can hit the /receive-notifications endpoint, and pull down the listed opportunities notifications. More info here

Acknowledge opportunities notifications.

Make sure you can hit the /ack-notifications endpoint, and acknowledge an opportunity notifications. More info here

Get an opportunity

Make sure you can hit the /get-opportunity endpoint, and get an opportunity. More info here

Retrieve a large collection

Make sure you can hit the /download-collection endpoint, and download a large collection. More info here

Respondent Gateway Testing

Return a list of attribute IDs and their statuses

Make sure you can hit the /list-attributes endpoint and pull down a list of attributes. More info here

Production Attributes

Please use the production version of the /list-attributes endpoint to map against the most commonly used attributes. The results from the QA version of /list-attributes are sorted arbitrarily.

Return info for the requested attribute.

Make sure you can hit the /get-attribute-info endpoint, and retrieve attribute information by attribute id. More info here

If you prefer to use the Respondent Gateway to create and update respondents:

Create a respondent

Make sure you can hit the /put-respondent endpoint, and create a respondent. More info here

Update a respondent

Once you’ve create a respondent via the /put-respondent endpoint, make sure you can update that same respondent via the same /put-respondentendpoint.