Action Required for APIs

If you have an existing integration that is using our REST API or Servlet API to make calls to our servers you may have to make a simple change to the URLs; to ensure that there is no interruption of service, this change needs to be implemented before June 10th, 2018.

*Example for REST APIs*
Before
https://{my-cloud-instance}.atlassian.net/rest/...
or
https://{my-cloud-instance}.jira.com/rest/...

New
https://app.tempo.io/rest-proxy/...

*Example for Servlet APIs*
Before
https://{my-cloud-instance}.atlassian.net/plugins/servlet/…
or
https://{my-cloud-instance}.jira.com/plugins/servlet/…

New
https://app.tempo.io/api/1/…

How do I know if I need to make this change?

If you are using APIs that were configured more than 6 months ago, it is likely that you will have to make an adjustment to the endpoint URL. Regardless of the timing of your integration, we urge everyone to take  a moment to verify the APIs they are using to ensure they follow the new convention.


Optional Action for Authorization and Parameters

Additionally, we’re happy to announce that the new, more secure authorization method for the REST APIs are ready to adopt as a recommended alternative to using the existing APIs. To ensure a smooth transition, there are some small but important steps you need to take to update your authorization method and parameters. As with any change, we strongly recommend that you verify the responses you receive once you implement the changes.

We encourage you adopt the new authorization method as soon as possible; we are actively updating and supporting these new methods, ensuring an optimal level of service.

Authorization method:

Our new authorization method supports two kinds of authorization tokens:

  1. A personal authorization token. This token is user-specific and will only return the data that the authenticated user doing the REST API call has permission to view. A personal authorization can be added and used by every user from the Tempo menu. The data returned from the API call by using this type of key is restricted to the users permission within Tempo/JIRA. Click here for details on creating personal authorization tokens.
  2. A machine-to-machine authorization token. The token is not user specific and will return all data from the REST API call. A machine-to-machine authorization token can only be added from Tempo Administrators (maintained in JIRA global permissions). For more details on creating machine-to-machine authorization tokens, click here or here. Note that machine-to-machine authorization tokens expire after 60 days.

 

Parameter changes:

There are some parameter changes you need to put in place when adopting the new authorization method; see the example below and click here for details.

Example:

Old

New

http://{JIRA_BASE_URL}/rest/tempo-timesheets/3/worklogs/

https://api.tempo.io/2/worklogs

dateFromstring

yyyy-MM-dd

from: (date-only)

Retrieve results starting with this date

dateTostring

yyyy-MM-dd

to: (date-only)

Retrieve results up to and including this date

usernamestring

name of the user you wish to get the worklogs for

updatedFrom: (date-only)

Retrieve results that have been updated from this date

projectKeystring

key of a project you wish to get the worklogs for

offset?: (integer - default: 0)

Skip over a number of elements by specifying an offset value for the query

accountKeystring

key of an account you wish to get the worklogs for

limit?: (integer - default: 50 - maximum: 1000)

Limit the number of elements on the response. The paging has been implemented to improve the performance of the worklog API. If the limit is less than the amount of worklogs you will get a "next" link within the “metadata” response.

teamIdstring

ID of the Team you wish to get the worklogs for

   

 

As always, if you have any questions, please don’t hesitate to reach out to support.

Cheers,

The Tempo Team

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.