README.md

zapi_csharp

ZAPI CSharp example JWT generate and make call to zapi

JWT Generator Reference

Download and add reference project(jwt generator) from the following repository.

Clone jwt library git clone https://github.com/jwt-dotnet/jwt.git

Or find JWT.DLL from following current project /ZapiCSharp/bin/Debug/JWT.dll

Define ZAPI Credentials (ZapiCSharp.cs) and API Information

//define ACCOUNT_ID
var ACCOUNT_ID = "123456:1234abcd-1234-abcd-1234-1234abcd1234";

//define AccessKey
var ACCESS_KEY = "MTZhOGQ5OTEtOTI0OS0zNzdmLWIyZTAtYTFkOTFhZTI2OTczIDEyMzQ1NjoxMjM0YWJjZC0xMjM0LWFiY2QtMTIzNC0xMjM0YWJjZDEyMzQgVVNFUl9ERUZBVUxUX05BTUU=";

//define SecretKey
var SECRET_KEY = "4b6v9i0kP7EjVzcuLMc4CUdkyq9AeTWheO2pr5CotGc";

//define Base Url
var BASE_URL = "https://prod-api.zephyr4jiracloud.com";


//define ContextPath
var CONTEXT_PATH = "/connect";

//define Expire Time
var EXPIRE_TIME = 3600;

//Get list of cycle(s) from api documents:
//https://zfjcloud.docs.apiary.io/#reference/cycle/get-list-of-cycles/get-list-of-cycles
//Split urls into following pattern to create jwt token and make call
//
//Note
//JWT token QUERY_STRING/query params has to place ascending ordered as atlassian's document:
//https://developer.atlassian.com/cloud/jira/platform/understanding-jwt/

//define api path
var RELATIVE_PATH = "/public/rest/api/1.0/cycles/search";

//define query string
var QUERY_STRING = "expand=action&projectId=10000&versionId=10000"

//Create canonical path for JWT. e.g: API Method & RELATIVE_PATH & QUERY_STRING (Asc Ordered)
var canonical_path = "GET&" + RELATIVE_PATH + "&" + QUERY_STRING;

//Details can be found here:
//Link: https://developer.atlassian.com/static/connect/docs/latest/concepts/understanding-jwt.html
var payload = new Dictionary<string, object>()
            {
                { "sub", ACCOUNT_ID },              //assign subject
                { "qsh", getQSH(canonical_path) },  //assign query string hash
                { "iss", ACCESS_KEY },              //assign issuer
                { "iat", iat },                     //assign issue at(in ms)
                { "exp", exp }                      //assign expiry time(in ms)
            };

string token = JWT.JsonWebToken.Encode(payload, SECRET_KEY, JWT.JwtHashAlgorithm.HS256);

Console.WriteLine(token);