net.worktrail.appapi

Class WorkTrailAppApi

java.lang.Object

net.worktrail.appapi.WorkTrailAppApi

public class WorkTrailAppApi
extends java.lang.Object

Entry point for accessing the WorkTrail API - see https://worktrail.net/en/api/ for details.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object	setServerUrl
static java.lang.String	WORKTRAIL_SERVER

Constructor Summary

Constructors

Constructor and Description
WorkTrailAppApi(java.lang.String appKey, java.lang.String secretApiKey, java.lang.String authToken) Creates a new api accessor instance.

Method Summary

Modifier and Type	Method and Description
void	cleanHubEntries()
CreateAuthResponse	createAuthRequest(WorkTrailAccessType accessType, WorkTrailScope[] scopes) Will request a new authentication request.
CreateHubEntriesResponse	createHubEntries(java.util.Collection<HubEntry> hubEntries)
Company	fetchCompany()
EmployeeListResponse	fetchEmployees()
WorkEntryListResponse	fetchWorkEntries(long lastModifyDate, long page)
java.lang.String	generateTestUser(WorkTrailAccessType accessType, WorkTrailScope[] scopes) generates a test user - will NOT work on https://worktrail.net !
java.lang.String	getAuthToken()
void	setAuthToken(java.lang.String authToken)
void	setServerUrl(java.lang.String serverUrl)
boolean	verifyAuthorization(java.lang.String requestKey) Checks whether the auth token which is represented by the request key was already authorized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WORKTRAIL_SERVER

public static final java.lang.String WORKTRAIL_SERVER

See Also:

Constant Field Values

setServerUrl

public java.lang.Object setServerUrl

Constructor Detail

WorkTrailAppApi

public WorkTrailAppApi(java.lang.String appKey,
                       java.lang.String secretApiKey,
                       java.lang.String authToken)

Creates a new api accessor instance.

Parameters:

appKey - Application key, provided by WorkTrail - https://worktrail.net/en/api/apps/

secretApiKey - When registering your app, you will also receive a secret api key.

authToken - Auth token is required to access secure api endpoints - ie. everything except createAuthRequest(WorkTrailAccessType, WorkTrailScope[]) (see linked documentation for auth details)

Method Detail

getAuthToken

public java.lang.String getAuthToken()

setAuthToken

public void setAuthToken(java.lang.String authToken)

createAuthRequest

public CreateAuthResponse createAuthRequest(WorkTrailAccessType accessType,
                                            WorkTrailScope[] scopes)
                                     throws RequestErrorException

Will request a new authentication request. The returned CreateAuthResponse will contain a URL your users will have to open in their browser to authenticate this app. See API documentation at https://worktrail.net/en/api/ for details about this parameters!

Parameters:

accessType - Which access type is required - company or employee level access.

scopes - All required scopes this app requires.

Returns:

CreateAuthResponse with a URL where the user can grant access to the app.

Throws:

RequestErrorException - if an error happens during authentication.

fetchEmployees

public EmployeeListResponse fetchEmployees()
                                    throws RequestErrorException

Throws:

RequestErrorException

fetchWorkEntries

public WorkEntryListResponse fetchWorkEntries(long lastModifyDate,
                                              long page)
                                       throws RequestErrorException

Throws:

RequestErrorException

createHubEntries

public CreateHubEntriesResponse createHubEntries(java.util.Collection<HubEntry> hubEntries)
                                          throws RequestErrorException

Throws:

RequestErrorException

cleanHubEntries

public void cleanHubEntries()
                     throws RequestErrorException

Throws:

RequestErrorException

verifyAuthorization

public boolean verifyAuthorization(java.lang.String requestKey)
                            throws RequestErrorException

Checks whether the auth token which is represented by the request key was already authorized.

Parameters:

requestKey -

Returns:

Throws:

RequestErrorException

setServerUrl

public void setServerUrl(java.lang.String serverUrl)

generateTestUser

public java.lang.String generateTestUser(WorkTrailAccessType accessType,
                                         WorkTrailScope[] scopes)
                                  throws RequestErrorException

generates a test user - will NOT work on https://worktrail.net !

Returns:

auth token.

Throws:

RequestErrorException

fetchCompany

public Company fetchCompany()
                     throws RequestErrorException

Throws:

RequestErrorException