Within the Teamwork Developer Portal, you can use your created apps in the app login flow or the log in with Teamwork component.
You must first register your app in the Teamwork Developer Portal before you can start building integrations.
App login flow
While accessing the Developer Portal, select your app to view it and navigate to the Credentials tab which contains all the required fields to use the App Login Flow.
Initiate authentication by directing your user to:
`XXX`is the return URI for your app/service.
`YYY`is the client ID from the Developer Portal.
For the redirect URIs, you can pass URIs such as:
- The result
chrome.identity.getRedirectURL()for Chrome extensions.
You can also pass a state query parameter which will be returned back to you in the final step.
It is up to you how you open the authentication window. You can use a modal/new window, a built-in API that handles it for you, or open the link up in the browser.
The user will authenticate either by email/password or one of the other login methods. This step does not require any work from the developer’s side.
You do not need to worry about making requests to multiple regions as the App Login Flow will handle everything.
The user is returned back to the login success page, at which point we open/redirect/navigate to the provided `redirect_uri.`
http(s) URLs, users will be
otherwise a message will
tell the user that it is
safe to close the window. You can also
modal/pop-up from your app
once you have received the
`code`query parameter is appended to the URI containing the temporary authentication token (which expires in 15 minutes), as well as the state parameter (if passed in Step 1).
Now that you have received the code, you can close any authentication popup/modal/child window (if needed).
You must make a HTTP POST request to:
A content-type header of
application/jsonneeds to be sent.
The request payload should be in JSON format and contain:
code– Retrieved using the previous step above *required field*
client_id– This will be generated using the Developer Portal where you register your app *required field*
redirect_uri– This will be generated using the Developer Portal where you register your app *required field*
client_secret– This will be generated using the Developer Portal where you register your app *required field*
You should store the `access_token` for all future requests, the basic installation data will provide you with the required URL under `apiEndPoint`.
You can now use the access token for authentication with our apps. The token should be passed under the
Authorizationheader as `Bearer XXX` where `XXX` is the token.
You can read more and find examples using the app login flow via our Developer Portal documentation.
Login with Teamwork
You can use our public component to allow users to log in to your app or service via their Teamwork account.
This works hand in hand with our app login flow. As a Teamwork 3rd party developer, you can avail of this feature. In order to use this:
- You will need to create an app in
- After you created an app, you will
access to our open source
After you have created an app and are ready to build the sign-in process, you can navigate to our GitHub repository. There are two approaches:
Whichever method you go with, you need to add the Teamwork button to your template or view by adding:
Using this button component will kick off the login process as it redirects the user to the launchpad login page. Continue the login process by following our app login flow.
You can read more about the associated parameters and find examples using the login component via our Developer Portal documentation.
For more information, see: Teamwork Developer Portal