(Objective-C) 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 v9.5.0.83 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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoCrypt2.h>
#import <CkoDateTime.h>
#import <NSString.h>
#import <CkoPrng.h>
#import <CkoStringBuilder.h>
#import <CkoXml.h>
#import <CkoBinData.h>
#import <CkoHttp.h>
#import <CkoHttpResponse.h>

// 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>

BOOL success;
CkoCrypt2 *crypt = [[CkoCrypt2 alloc] init];

CkoDateTime *dtNow = [[CkoDateTime alloc] init];
[dtNow SetFromCurrentSystemTime];
NSLog(@"%@",[dtNow GetAsTimestamp: NO]);

// The hash algorithm for the password is SHA512 (not SHA3-512).
crypt.HashAlgorithm = @"sha512";
crypt.EncodingMode = @"hex";
NSString *myPassword = @"my-password";
NSString *passwordHash = [crypt HashStringENC: myPassword];

// Generate a random request ID like "RID215118906689"
CkoPrng *prng = [[CkoPrng alloc] init];
CkoStringBuilder *sbRequestId = [[CkoStringBuilder alloc] init];
[sbRequestId Append: @"RID"];
[sbRequestId Append: [prng RandomString: [NSNumber numberWithInt: 12] bDigits: YES bLower: NO bUpper: NO]];
NSLog(@"%@%@",@"generated requestId = ",[sbRequestId GetAsString]);

// Calculate the requestSignature
crypt.HashAlgorithm = @"sha3-512";
NSString *signatureKey = @"ce-8f5e-215119fa7dd621DLMRHRLH2S";

CkoStringBuilder *sbFinalHashBase = [[CkoStringBuilder alloc] init];

// First append the timestamp because we are going to remove certain chars/parts.
[sbFinalHashBase Append: [dtNow GetAsTimestamp: NO]];
int numReplaced = [[sbFinalHashBase Replace: @"Z" replacement: @""] intValue];
numReplaced = [[sbFinalHashBase Replace: @"-" replacement: @""] intValue];
numReplaced = [[sbFinalHashBase Replace: @":" replacement: @""] intValue];
numReplaced = [[sbFinalHashBase Replace: @"T" replacement: @""] intValue];

// Prepend the requestId and append the signatureKey
[sbFinalHashBase Prepend: [sbRequestId GetAsString]];
[sbFinalHashBase Append: signatureKey];

// Calculate first (and only) index hash.
NSString *invoiceOperation = @"ANNUL";
NSString *invoiceData = @"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4=";

CkoStringBuilder *sbHashBase = [[CkoStringBuilder alloc] init];
[sbHashBase Append: invoiceOperation];
[sbHashBase Append: invoiceData];
NSString *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...)
NSString *requestSignature = [crypt HashStringENC: [sbFinalHashBase GetAsString]];

// Load our recently obtained exchange token.
// See Hungary NAV Invoicing Token Exchange Sample Code
CkoXml *xmlExchangeToken = [[CkoXml alloc] init];
success = [xmlExchangeToken LoadXmlFile: @"qa_data/tokens/nav_exchange_token.xml"];
if (success == NO) {
    NSLog(@"%@",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..
NSString *encodedEncryptedExchangeToken = [xmlExchangeToken GetChildContent: @"encodedExchangeToken"];

// Decode to binary.
CkoBinData *bdExchangeToken = [[CkoBinData alloc] init];
[bdExchangeToken AppendEncoded: encodedEncryptedExchangeToken encoding: @"base64"];

// Decrypt using your 16-digit replacement key:
crypt.CryptAlgorithm = @"aes";
crypt.CipherMode = @"ecb";
crypt.KeyLength = [NSNumber numberWithInt:128];
crypt.EncodingMode = @"base64";
// Pass your 16-digit replacement key here:
[crypt SetEncodedKey: @"99952BBAAAAA8XYZ" encoding: @"ascii"];
[crypt DecryptBd: bdExchangeToken];
NSString *exchangeToken = [bdExchangeToken GetString: @"utf-8"];
NSLog(@"%@%@",@"exchange token = ",exchangeToken);

// Now build the XML..
CkoXml *xml = [[CkoXml alloc] init];
xml.Tag = @"ManageAnnulmentRequest";
[xml AddAttribute: @"xmlns" value: @"http://schemas.nav.gov.hu/OSA/2.0/api"];
[xml UpdateChildContent: @"header|requestId" value: [sbRequestId GetAsString]];
[xml UpdateChildContent: @"header|timestamp" value: [dtNow GetAsTimestamp: NO]];
[xml UpdateChildContent: @"header|requestVersion" value: @"2.0"];
[xml UpdateChildContent: @"header|headerVersion" value: @"1.0"];
[xml UpdateChildContent: @"user|login" value: @"lwilsmn0uqdxe6u"];
[xml UpdateChildContent: @"user|passwordHash" value: passwordHash];
[xml UpdateChildContent: @"user|taxNumber" value: @"11111111"];
[xml UpdateChildContent: @"user|requestSignature" value: requestSignature];
[xml UpdateChildContent: @"software|softwareId" value: @"123456789123456789"];
[xml UpdateChildContent: @"software|softwareName" value: @"string"];
[xml UpdateChildContent: @"software|softwareOperation" value: @"LOCAL_SOFTWARE"];
[xml UpdateChildContent: @"software|softwareMainVersion" value: @"string"];
[xml UpdateChildContent: @"software|softwareDevName" value: @"string"];
[xml UpdateChildContent: @"software|softwareDevContact" value: @"string"];
[xml UpdateChildContent: @"software|softwareDevCountryCode" value: @"HU"];
[xml UpdateChildContent: @"software|softwareDevTaxNumber" value: @"string"];
[xml UpdateChildContent: @"exchangeToken" value: exchangeToken];
[xml UpdateChildContent: @"annulmentOperations|annulmentOperation|index" value: @"1"];
[xml UpdateChildContent: @"annulmentOperations|annulmentOperation|annulmentOperation" value: invoiceOperation];
[xml UpdateChildContent: @"annulmentOperations|annulmentOperation|invoiceAnnulment" value: invoiceData];

// POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
CkoHttp *http = [[CkoHttp alloc] init];
http.Accept = @"application/xml";
[http SetRequestHeader: @"Content-Type" value: @"application/xml"];
NSString *endpoint = @"https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment";
CkoHttpResponse *resp = [http PostXml: endpoint xmlDoc: [xml GetXml] charset: @"utf-8"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);

CkoXml *respXml = [[CkoXml alloc] init];
[respXml LoadXml: resp.BodyStr];
NSLog(@"%@",@"Response body:");
NSLog(@"%@",[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

NSString *ManageAnnulmentResponse_xmlns = [respXml GetAttrValue: @"xmlns"];
NSString *ManageAnnulmentResponse_xmlns_ns2 = [respXml GetAttrValue: @"xmlns:ns2"];
NSString *requestId = [respXml GetChildContent: @"header|requestId"];
NSString *timestamp = [respXml GetChildContent: @"header|timestamp"];
NSString *requestVersion = [respXml GetChildContent: @"header|requestVersion"];
NSString *headerVersion = [respXml GetChildContent: @"header|headerVersion"];
NSString *funcCode = [respXml GetChildContent: @"result|funcCode"];
NSString *softwareId = [respXml GetChildContent: @"software|softwareId"];
NSString *softwareName = [respXml GetChildContent: @"software|softwareName"];
NSString *softwareOperation = [respXml GetChildContent: @"software|softwareOperation"];
NSString *softwareMainVersion = [respXml GetChildContent: @"software|softwareMainVersion"];
NSString *softwareDevName = [respXml GetChildContent: @"software|softwareDevName"];
NSString *softwareDevContact = [respXml GetChildContent: @"software|softwareDevContact"];
NSString *softwareDevCountryCode = [respXml GetChildContent: @"software|softwareDevCountryCode"];
NSString *softwareDevTaxNumber = [respXml GetChildContent: @"software|softwareDevTaxNumber"];
NSString *transactionId = [respXml GetChildContent: @"transactionId"];