Versions Compared

Old Version 2

changes.mady.by.user Weronika Spaleniak

Saved on

compared with

New Version Current

changes.mady.by.user Weronika Spaleniak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

O ‘OKR for Jira’ disponibiliza a API REST para a praticidade da integração com ferramentas
externas.
Se você precisa de orientação com uma pessoa da área técnica da nossa equipe para ajudá-lo com
o uso da API, entre em contato conosco através do support@appfire.com

Gerar um token API
Você precisa gerar um token API para usar a sua API.
Para gerar um token, navegue para o menu do lado esquerdo no app OKR for Jira. Depois
selecione ‘Configurações’, e o item ‘API’ no menu.

...

Na página, clique no botão 'Gerar um novo token’ no canto superior direito da página.

Note

Copie o token criado em um local seguro. Você não poderá visualizá-lo novamente.

...

Solicitação de autenticação com o seu token da API

Todas as solicitações para a API devem incluir o cabeçalho API-Token, que contém o token
gerado na etapa anterior.
Se não houver o cabeçalho, você receberá uma resposta 400 Bad Request.
Use o cabeçalho API-Token e não Authentication.

Tabela de administrador da API

O OKR for Jira fornece um modo de supervisionar todos os tokens da API criados dentro da sua
organização.
Os usuários com a permissão API_ADMIN_TABLE_ACCESS têm acesso a uma visão expandida na
página de configurações da API.
A tabela de administrador da API permite que você visualize, renomeie ou revogue qualquer
token dentro da sua organização.

...

Resposta da API

Todos os métodos de busca da API retornam a mesma estrutura de objeto JSON. A apresentação
dos dados depende do seu parâmetro de consulta.

 

Expand
titleExemplo de objeto de resposta:
Code Block
{
	"okrs": [
		{
			"id": "5fda249d289742000406b3e4",
			"key": "O-2",
			"name": "Become more mature company",
			"description": "<p>This quarter we will be focusing on improving our performance.</p><p></p>",
			"parentObjectiveId": null,
			"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
			"collaboratorAccountIds": [],
			"percentDone": 8.333333333333332,
			"created": "2020-12-16T15:15:41+0000",
			"startDate": "2021-01-01T00:00:00+0000",
			"deadline": "2021-03-31T23:59:59+0000",
			"labelIds": [],
			"teamIds": [],
			"krIds": [
				"605480b190c42b0003385170",
				"6061e921e2f4470003bc3210"
			],
			"childObjectiveIds": [
				"5fdb72c63d2cf000035ceb37",
				"60743135b347480003dc6a9c",
				"61f9367df9aa7f0e4024a6fe"
			],
			"latestUpdate": {
				"entityId": "5fda249d289742000406b3e4",
				"status": "ON_TRACK",
				"created": "2021-05-05T12:15:14+0000",
				"value": null,
				"description": ""
			},
			"periodAliasId": "602a6a2717378700039f342a",
			"weight": 0
		}
	],
	"krs": [
		{
			"id": "5fda249d289742000406b3e5",
			"key": "KR-2",
			"name": "adda",
			"description": null,
			"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
			"issueIds": [
				"10003"
			],
			"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
			"collaboratorAccountIds": [],
			"percentDone": 0.0,
			"created": "2020-12-16T15:15:41+0000",
			"startDate": "2021-01-05T00:00:00+0000",
			"deadline": "2021-03-28T00:59:59+0000",
			"labelIds": [],
			"teamIds": [],
			"periodAliasId": null,
			"latestUpdate": {
				"entityId": "61c993aaa0fd9b768a0fb47d",
				"status": "AT_RISK",
				"created": "2021-12-27T10:21:30+0000",
				"value": 0.0,
				"description": null
			},
			"unit": null,
			"currentProgressDefinition": {
				"type": "STANDARD",
				"startValue": 0.0,
				"desiredValue": 22.0,
				"jql": null
			},
			"weight": 1
		}
	],
	"teams": [
		{
			"id": "605df77c6e53750003068c7d",
			"name": "lets go!"
		}
	],
	"periods": [
		{
			"id": "602a6a2717378700039f342a",
			"name": "Q1 Y2021",
			"startDate": "2021-01-01T00:00:00+0000",
			"deadline": "2021-03-31T23:59:59+0000"
		}
	],
	"labels": [
		{
			"id": "611a18f6c385f85c13ac860a",
			"name": "Research"
		}
	]
}