Authenticate




Important note about API versions


If you are using Dovico Timesheet version 13 or below, you should use API version 5. If using version 14, use API version 6.




Versions 1 through 6

The API calls listed below enable a Dovico trusted app to authenticate a user's credentials (Company Name, User ID, and Password) rather than requiring the user input their Data Access Token for Apps directly.



Authenticate


POST Authenticate/

Returns the user's Data Access Token for Apps which can then be used for future API calls.

Security Check: The Company Name, Username, and Password must be valid and employee access to the API must be enabled ('Allow Employees to use 3rd Party Apps' in the Database Options view of Dovico Timesheet)

Example XML request:
 
        URI: https://api.dovico.com/Authenticate/?version=6
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Authenticate/?version=6" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=""" -H "Content-Type: text/xml" --data "<UserInfo><CompanyName>XYZCompanyInc</CompanyName><UserName>ssmith27</UserName><Password>c0Mp1!cat3D</Password></UserInfo>"
Fields for UserInfo
  • CompanyName (required - string)
  • UserName (required - string)
  • Password (required - string) - case sensitive


Example JSON request:
 
        URI: https://api.dovico.com/Authenticate/?version=6
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Authenticate/?version=6" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=""" -H "Content-Type: application/json" --data "{""CompanyName"":""XYZCompanyInc"",""UserName"":""ssmith27"",""Password"":""c0Mp1!cat3D""}"
Fields
  • CompanyName (required - string)
  • UserName (required - string)
  • Password (required - string)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <DataAccessToken>e7d1e55015ee4ecebe5298cb439344fd.593</DataAccessToken>
        </Result>

Fields for Result
DataAccessToken (string - the value to use in the Authorization header, user_token field, for future API calls)

Example JSON response:
 
        {
            "DataAccessToken":"e7d1e55015ee4ecebe5298cb439344fd.593"
        }

Fields
DataAccessToken (string - the value to use in the Authorization header, user_token field, for future API calls)