Conformance Sandbox Configuration

This page describes the process of configuring DCSA conformance sandboxes in preparation for using them for measuring the conformance of your application with the implemented DCSA standard.

The sandbox configuration page is displayed right after creating a sandbox. Later on it can be accessed by navigating to the sandbox page from the home page and then clicking the cog icon (⚙️) next to the sandbox name.

Creating a sandbox is described in the Conformance Sandboxes page.

To access all conformance documentation, return to the DCSA Conformance page.

 

Sandbox name

Choose a unique, meaningful name for your sandbox, one that will allow you to easily identify it in the list of your sandboxes.

 

Connecting to the sandbox

This section displays the sandbox base URL, as well as the full URL of each endpoint implemented by the synthetic counterpart of your application. Use the base URL or the individual endpoint URLs to configure your application to connect to its DCSA synthetic counterpart during conformance scenarios.

 

Authenticating to the sandbox

Whenever your application makes an API call to its DCSA synthetic counterpart running in the conformance sandbox, it must include an HTTP header name and value for authentication and authorization. Copy the header name and value from this section and use them to configure your application.

 

Connecting to your application

Use this section to configure your application's DCSA synthetic counterpart running in the sandbox to connect to the DCSA API endpoints implemented by your application.

The "Application base URL" is the common base URL shared by all the endpoints of your application. By default, if you leave the checkbox "Use custom endpoint URIs" unchecked, the sandbox appends the endpoint URI defined in the DCSA standard to build the full URL with which to connect to your application through that endpoint.

 

Check that each of these endpoint URLs matches the URL of the corresponding endpoint in your application. If your application uses custom endpoint configuration, check the "Use custom endpoint URIs" checkbox and adjust one or more endpoint URIs, checking that the resulting URLs are correct for all endpoints:

If you need to whitelist the IP address from which the sandbox makes API requests to your application, use the IP address shown at the bottom of this configuration section.

 

Authenticating to your application

Provide an authentication header name and value that your application's DCSA synthetic counterpart running in the sandbox will include in the header of each API request made to your application.

If your application requires more than one authentication and authorization header, use this section to provide these additional header names and values.

 

If your application requires OAuth2

There is currently no explicit support for OAuth2 in the conformance framework, but there is a simple workaround for configuring a sandbox to connect to your application using OAuth2:

  1. Generate an OAuth2 bearer token for your application.
  2. Set the "Sandbox counterpart authentication header name" to "Authorization".
  3. Set the "Sandbox counterpart authentication header value" to "Bearer" followed by a space and by the OAuth2 bearer token.

Depending on the expiration of your bearer token, it may be convenient to keep the sandbox configuration page open in a separate tab and to generate and apply a new token before running each scenario (or in the case of complex scenarios that require lengthy manual operations within your system, before each action).