|
|
(JavaScript) Hungary NAV Manage Annulment Request
Demonstrates the manageAnnulment request for the Hungarian NAV Online Invoicing System REST API v2.0. Note: This example requires Chilkat v11.0.0 or greater. For more information, see https://onlineszamla.nav.gov.hu/api/files/container/download/Online%20Szamla_Interfesz%20specifik%C3%A1ci%C3%B3_EN_v2.0.pdf
var success = false;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Build the following XML:
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
// <?xml version="1.0" encoding="UTF-8"?>
// <ManageAnnulmentRequest xmlns="http://schemas.nav.gov.hu/OSA/2.0/api">
// <header>
// <requestId>RID338592103413</requestId>
// <timestamp>2019-09-11T13:37:09.385Z</timestamp>
// <requestVersion>2.0</requestVersion>
// <headerVersion>1.0</headerVersion>
// </header>
// <user>
// <login>lwilsmn0uqdxe6u</login>
// <passwordHash>2F43840A882CFDB7DB0 ... F6CA57FE8CD74DC28E</passwordHash>
// <taxNumber>11111111</taxNumber>
// <requestSignature>A297E3BD9 ... 1959ADFAF5</requestSignature>
// </user>
// <software>
// <softwareId>123456789123456789</softwareId>
// <softwareName>string</softwareName>
// <softwareOperation>LOCAL_SOFTWARE</softwareOperation>
// <softwareMainVersion>string</softwareMainVersion>
// <softwareDevName>string</softwareDevName>
// <softwareDevContact>string</softwareDevContact>
// <softwareDevCountryCode>HU</softwareDevCountryCode>
// <softwareDevTaxNumber>string</softwareDevTaxNumber>
// </software>
// <exchangeToken>dbd03076-3a9b-4312-bbbb-0cee3a6472572P11CS49ASIL</exchangeToken>
// <annulmentOperations>
// <annulmentOperation>
// <index>1</index>
// <annulmentOperation>ANNUL</annulmentOperation>
// <invoiceAnnulment>PD94bWwgdm ... ubnVsbWVudD4=</invoiceAnnulment>
// </annulmentOperation>
// </annulmentOperations>
// </ManageAnnulmentRequest>
var crypt = new CkCrypt2();
var dtNow = new CkDateTime();
dtNow.SetFromCurrentSystemTime();
console.log(dtNow.GetAsTimestamp(false));
// The hash algorithm for the password is SHA512 (not SHA3-512).
crypt.HashAlgorithm = "sha512";
crypt.EncodingMode = "hex";
var myPassword = "my-password";
var passwordHash = crypt.HashStringENC(myPassword);
// Generate a random request ID like "RID215118906689"
var prng = new CkPrng();
var sbRequestId = new CkStringBuilder();
sbRequestId.Append("RID");
sbRequestId.Append(prng.RandomString(12,true,false,false));
console.log("generated requestId = " + sbRequestId.GetAsString());
// Calculate the requestSignature
crypt.HashAlgorithm = "sha3-512";
var signatureKey = "ce-8f5e-215119fa7dd621DLMRHRLH2S";
var sbFinalHashBase = new CkStringBuilder();
// First append the timestamp because we are going to remove certain chars/parts.
sbFinalHashBase.Append(dtNow.GetAsTimestamp(false));
var numReplaced = sbFinalHashBase.Replace("Z","");
numReplaced = sbFinalHashBase.Replace("-","");
numReplaced = sbFinalHashBase.Replace(":","");
numReplaced = sbFinalHashBase.Replace("T","");
// Prepend the requestId and append the signatureKey
sbFinalHashBase.Prepend(sbRequestId.GetAsString());
sbFinalHashBase.Append(signatureKey);
// Calculate first (and only) index hash.
var invoiceOperation = "ANNUL";
var invoiceData = "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4=";
var sbHashBase = new CkStringBuilder();
sbHashBase.Append(invoiceOperation);
sbHashBase.Append(invoiceData);
var firstHash = crypt.HashStringENC(sbHashBase.GetAsString());
// Append the index hash to the final hash base.
sbFinalHashBase.Append(firstHash);
// Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
var requestSignature = crypt.HashStringENC(sbFinalHashBase.GetAsString());
// Load our recently obtained exchange token.
// See Hungary NAV Invoicing Token Exchange Sample Code
var xmlExchangeToken = new CkXml();
success = xmlExchangeToken.LoadXmlFile("qa_data/tokens/nav_exchange_token.xml");
if (success == false) {
console.log(xmlExchangeToken.LastErrorText);
return;
}
// Get the base64 encoded/encrypted exchange token.
// IMPORTANT: Make sure to use the exchange token before it expires.
// If it expired, then get a new one..
var encodedEncryptedExchangeToken = xmlExchangeToken.GetChildContent("encodedExchangeToken");
// Decode to binary.
var bdExchangeToken = new CkBinData();
bdExchangeToken.AppendEncoded(encodedEncryptedExchangeToken,"base64");
// Decrypt using your 16-digit replacement key:
crypt.CryptAlgorithm = "aes";
crypt.CipherMode = "ecb";
crypt.KeyLength = 128;
crypt.EncodingMode = "base64";
// Pass your 16-digit replacement key here:
crypt.SetEncodedKey("99952BBAAAAA8XYZ","ascii");
crypt.DecryptBd(bdExchangeToken);
var exchangeToken = bdExchangeToken.GetString("utf-8");
console.log("exchange token = " + exchangeToken);
// Now build the XML..
var xml = new CkXml();
xml.Tag = "ManageAnnulmentRequest";
xml.AddAttribute("xmlns","http://schemas.nav.gov.hu/OSA/2.0/api");
xml.UpdateChildContent("header|requestId",sbRequestId.GetAsString());
xml.UpdateChildContent("header|timestamp",dtNow.GetAsTimestamp(false));
xml.UpdateChildContent("header|requestVersion","2.0");
xml.UpdateChildContent("header|headerVersion","1.0");
xml.UpdateChildContent("user|login","lwilsmn0uqdxe6u");
xml.UpdateChildContent("user|passwordHash",passwordHash);
xml.UpdateChildContent("user|taxNumber","11111111");
xml.UpdateChildContent("user|requestSignature",requestSignature);
xml.UpdateChildContent("software|softwareId","123456789123456789");
xml.UpdateChildContent("software|softwareName","string");
xml.UpdateChildContent("software|softwareOperation","LOCAL_SOFTWARE");
xml.UpdateChildContent("software|softwareMainVersion","string");
xml.UpdateChildContent("software|softwareDevName","string");
xml.UpdateChildContent("software|softwareDevContact","string");
xml.UpdateChildContent("software|softwareDevCountryCode","HU");
xml.UpdateChildContent("software|softwareDevTaxNumber","string");
xml.UpdateChildContent("exchangeToken",exchangeToken);
xml.UpdateChildContent("annulmentOperations|annulmentOperation|index","1");
xml.UpdateChildContent("annulmentOperations|annulmentOperation|annulmentOperation",invoiceOperation);
xml.UpdateChildContent("annulmentOperations|annulmentOperation|invoiceAnnulment",invoiceData);
// POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
var http = new CkHttp();
http.Accept = "application/xml";
var endpoint = "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment";
var resp = new CkHttpResponse();
success = http.HttpStr("POST",endpoint,xml.GetXml(),"utf-8","application/xml",resp);
if (success == false) {
console.log(http.LastErrorText);
return;
}
console.log("Response status code = " + resp.StatusCode);
var respXml = new CkXml();
respXml.LoadXml(resp.BodyStr);
console.log("Response body:");
console.log(respXml.GetXml());
// The result looks like this:
// <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
// <ManageAnnulmentResponse xmlns="http://schemas.nav.gov.hu/OSA/2.0/api" xmlns:ns2="http://schemas.nav.gov.hu/OSA/2.0/data">
// <header>
// <requestId>RID465317110495</requestId>
// <timestamp>2020-03-25T15:08:40Z</timestamp>
// <requestVersion>2.0</requestVersion>
// <headerVersion>1.0</headerVersion>
// </header>
// <result>
// <funcCode>OK</funcCode>
// </result>
// <software>
// <softwareId>123456789123456789</softwareId>
// <softwareName>string</softwareName>
// <softwareOperation>LOCAL_SOFTWARE</softwareOperation>
// <softwareMainVersion>string</softwareMainVersion>
// <softwareDevName>string</softwareDevName>
// <softwareDevContact>string</softwareDevContact>
// <softwareDevCountryCode>HU</softwareDevCountryCode>
// <softwareDevTaxNumber>string</softwareDevTaxNumber>
// </software>
// <transactionId>2WT6XG9LQ0U9VQNA</transactionId>
// </ManageAnnulmentResponse>
// Use this online tool to generate parsing code from sample XML:
// Generate Parsing Code from XML
var ManageAnnulmentResponse_xmlns = respXml.GetAttrValue("xmlns");
var ManageAnnulmentResponse_xmlns_ns2 = respXml.GetAttrValue("xmlns:ns2");
var requestId = respXml.GetChildContent("header|requestId");
var timestamp = respXml.GetChildContent("header|timestamp");
var requestVersion = respXml.GetChildContent("header|requestVersion");
var headerVersion = respXml.GetChildContent("header|headerVersion");
var funcCode = respXml.GetChildContent("result|funcCode");
var softwareId = respXml.GetChildContent("software|softwareId");
var softwareName = respXml.GetChildContent("software|softwareName");
var softwareOperation = respXml.GetChildContent("software|softwareOperation");
var softwareMainVersion = respXml.GetChildContent("software|softwareMainVersion");
var softwareDevName = respXml.GetChildContent("software|softwareDevName");
var softwareDevContact = respXml.GetChildContent("software|softwareDevContact");
var softwareDevCountryCode = respXml.GetChildContent("software|softwareDevCountryCode");
var softwareDevTaxNumber = respXml.GetChildContent("software|softwareDevTaxNumber");
var transactionId = respXml.GetChildContent("transactionId");
|
