Ping the server

After setting up your authentication method, use the "ping" command to verify that the service is running.

Example:

curl
    -X GET
    -H 'Accept: application/json'
    -H 'Authorization: Basic ${btoa(`:`)}'
    'https://sandbox-rest.avatax.com/api/v2/utilities/ping'

You’ll see a response similar to the following upon success:

Example:

{
  "version": "1.0.0.0",
  "authenticated": true,
  "authenticationType": "UsernamePassword",
  "authenticatedUserName": "TestUser",
  "authenticatedUserId": 98765,
  "authenticatedAccountId": 123456789,
  "authenticatedCompanyId": 123456789,
  "crmid": "1111"
}

Tip

You only need to use Ping once. If you want to periodically verify that the service is running, use a webhook and subscribe to status.avalara.com instead of pinging multiple times.