Design the user experience

Whether you are a technology partner working to become certified or an API customer, this section describes how you should design your AvaTax application.

Certification for technology partners:

What should your integration’s user interface look like? What design elements should you include? For partner certification, this section describes the design elements that are necessary to become certified. These UI elements have been carefully crafted to help you create an integration that is straightforward and uncomplicated for your users and to help ensure that your integration is tax compliant.

The badge requirements are broken down into the following types:

• Mandatory: This design element is required to become certified.
• Suggested: This design element is not required, but we recommend that your UI includes suggested elements.

A mockup including a path through is available here.

Mandatory/Suggested

Use cases

Notes

Mandatory

Setup Avalara Credentials

The best practice is to enhance the UI for easy entry of Avalara credentials including:

• Client ID Token
• Secret Token
• Avalara end point URL

Mandatory

Test Authentication Connection - Health Service (PING)

There are two methods available:

• One for authentication /AUTH
• another for service availability /PING

Mandatory

Enable/Disable Service Utilization

In this case, the user can enable or disable the AvaTax BR service at any time. The flag will indicate that the service is operational.

Mandatory

Comprehensive Logging

Given that all transactions are based on request/response JSON, the connector should provide logs of these transactions for troubleshooting, if necessary. Partners can define the time necessary to keep those data on the system.

Suggested

Set the timeout to API calls

Set a timeout to API call, as recommended by best practices.

Mandatory

Security Communication Protocol – HTTPS/SLL

The platform (ERP´s, middleware’s, e-commerce, etc.) that will be the API calls should be prepared to support TLS 1.2.

Previous versions will be discontinued and are not recommended.

Mandatory

Checking Environment 

Provide evidence that demonstrates which environment (Production or Sandbox) the client/partner is operating

Mandatory

Version

Inform version compatibility with the ERP with the connector.

Mandatory

Architecture

Inform the connector architecture, as well as the prerequisites for operation, either on Premise or in the cloud.

Mandatory

Namespaces – SAP

Exclusive for partners who will develop a connector for SAP ERP, it is mandatory to have a reserved domain within the SAP system, which must be active and licensed.

Previous

Next