Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Ruby Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Security Token Service
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon SP-API
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Banco Inter
Belgian eHealth Platform
Bitfinex v2 REST
Bluzone
BrickLink
Bunny CDN
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Egypt eReceipt
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Google Translate
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
Jira
Lightspeed
MYOB
Magento
Mailgun
Mastercard

MedTunnel
MercadoLibre
MessageMedia
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
OpenAI ChatGPT
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
Trello
Twilio
Twitter API v2
Twitter v1
UPS
UniPin
VoiceBase
Vonage
WaTrend
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yapily
Yousign
ZATCA
Zendesk
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(Ruby) Hungary NAV Manage Invoice Request

Demonstrates the manageInvoice 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 Ruby Downloads

Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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"?>
# <ManageInvoiceRequest xmlns="http://schemas.nav.gov.hu/OSA/2.0/api">
# 	<header>
# 		<requestId>RID181837288942</requestId>
# 		<timestamp>2019-09-11T12:44:55.442Z</timestamp>
# 		<requestVersion>2.0</requestVersion>
# 		<headerVersion>1.0</headerVersion>
# 	</header>
# 	<user>
# 		<login>lwilsmn0uqdxe6u</login>
# 		<passwordHash>2F43840A882CFDB7DB0FEC07D419D030D864B47B6B541DC280EF81B937B7A176E33C052B0D26638CC18A7A2C08D8D311733078A774BF43F6CA57FE8CD74DC28E</passwordHash>
# 		<taxNumber>11111111</taxNumber>
# 		<requestSignature>E4D191A48EE8828A1E84C1F841A2B4E1699ECB49C4CDA1DC7A057765FD935872219644CC2B5A93B8A344404E4FD8ECA4902B5DBCF993E768DC558B0F0281E775</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>b1aca173-d9e8-4561-9237-0511eed99eaa2P0ZHLXBRI2U</exchangeToken>
# 	<invoiceOperations>
# 		<compressedContent>false</compressedContent>
# 		<invoiceOperation>
# 			<index>1</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData1 XML file</invoiceData>
# 		</invoiceOperation>
# 		<invoiceOperation>
# 			<index>2</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData2 XML file</invoiceData>
# 		</invoiceOperation>
# 		<invoiceOperation>
# 			<index>3</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData3 XML file</invoiceData>
# 		</invoiceOperation>
# 	</invoiceOperations>
# </ManageInvoiceRequest>
# 

# First load the invoiceData for the 3 XML invoice files we'll be sending.
bdInvoiceData1 = Chilkat::CkBinData.new()
bdInvoiceData2 = Chilkat::CkBinData.new()
bdInvoiceData3 = Chilkat::CkBinData.new()
success = bdInvoiceData1.LoadFile("qa_data/nav_invoicing/invoiceData1.xml")
success = bdInvoiceData2.LoadFile("qa_data/nav_invoicing/invoiceData2.xml")
success = bdInvoiceData3.LoadFile("qa_data/nav_invoicing/invoiceData3.xml")
if (success == false)
    print "Failed to load invoice data." + "\n";
    exit
end

crypt = Chilkat::CkCrypt2.new()

dtNow = Chilkat::CkDateTime.new()
dtNow.SetFromCurrentSystemTime()
print dtNow.getAsTimestamp(false) + "\n";

# The hash algorithm for the password is SHA512 (not SHA3-512).
crypt.put_HashAlgorithm("sha512")
crypt.put_EncodingMode("hex")
myPassword = "my-password"
passwordHash = crypt.hashStringENC(myPassword)

# Generate a random request ID like "RID215118906689"
prng = Chilkat::CkPrng.new()
sbRequestId = Chilkat::CkStringBuilder.new()
sbRequestId.Append("RID")
sbRequestId.Append(prng.randomString(12,true,false,false))
print "generated requestId = " + sbRequestId.getAsString() + "\n";

# Calculate the requestSignature
crypt.put_HashAlgorithm("sha3-512")
signatureKey = "ce-8f5e-215119fa7dd621DLMRHRLH2S"

sbFinalHashBase = Chilkat::CkStringBuilder.new()

# First append the timestamp because we are going to remove certain chars/parts.
sbFinalHashBase.Append(dtNow.getAsTimestamp(false))
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 each index hash and add it to the sbFinalHashBase
sbHashBase = Chilkat::CkStringBuilder.new()
sbHashBase.Append("CREATE")
sbHashBase.Append(bdInvoiceData1.getEncoded("base64"))
indexHash = crypt.hashStringENC(sbHashBase.getAsString())
sbFinalHashBase.Append(indexHash)

sbHashBase.Clear()
sbHashBase.Append("CREATE")
sbHashBase.Append(bdInvoiceData2.getEncoded("base64"))
indexHash = crypt.hashStringENC(sbHashBase.getAsString())
sbFinalHashBase.Append(indexHash)

sbHashBase.Clear()
sbHashBase.Append("CREATE")
sbHashBase.Append(bdInvoiceData3.getEncoded("base64"))
indexHash = crypt.hashStringENC(sbHashBase.getAsString())
sbFinalHashBase.Append(indexHash)

# Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
requestSignature = crypt.hashStringENC(sbFinalHashBase.getAsString())

# Load our recently obtained exchange token.
# See Hungary NAV Invoicing Token Exchange Sample Code
xmlExchangeToken = Chilkat::CkXml.new()
success = xmlExchangeToken.LoadXmlFile("qa_data/tokens/nav_exchange_token.xml")
if (success == false)
    print xmlExchangeToken.lastErrorText() + "\n";
    exit
end

# 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..
encodedEncryptedExchangeToken = xmlExchangeToken.getChildContent("encodedExchangeToken")

# Decode to binary.
bdExchangeToken = Chilkat::CkBinData.new()
bdExchangeToken.AppendEncoded(encodedEncryptedExchangeToken,"base64")

# Decrypt using your 16-digit replacement key:
crypt.put_CryptAlgorithm("aes")
crypt.put_CipherMode("ecb")
crypt.put_KeyLength(128)
crypt.put_EncodingMode("base64")
# Pass your 16-digit replacement key here:
crypt.SetEncodedKey("99952BBAAAAA8XYZ","ascii")
crypt.DecryptBd(bdExchangeToken)
exchangeToken = bdExchangeToken.getString("utf-8")
print "exchange token = " + exchangeToken + "\n";

# Now build the XML..
xml = Chilkat::CkXml.new()
xml.put_Tag("ManageInvoiceRequest")
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("invoiceOperations|compressedContent","false")
xml.UpdateChildContent("invoiceOperations|invoiceOperation|index","1")
xml.UpdateChildContent("invoiceOperations|invoiceOperation|invoiceOperation","CREATE")
xml.UpdateChildContent("invoiceOperations|invoiceOperation|invoiceData",bdInvoiceData1.getEncoded("base64"))
xml.UpdateChildContent("invoiceOperations|invoiceOperation[1]|index","2")
xml.UpdateChildContent("invoiceOperations|invoiceOperation[1]|invoiceOperation","CREATE")
xml.UpdateChildContent("invoiceOperations|invoiceOperation[1]|invoiceData",bdInvoiceData2.getEncoded("base64"))
xml.UpdateChildContent("invoiceOperations|invoiceOperation[2]|index","3")
xml.UpdateChildContent("invoiceOperations|invoiceOperation[2]|invoiceOperation","CREATE")
xml.UpdateChildContent("invoiceOperations|invoiceOperation[2]|invoiceData",bdInvoiceData3.getEncoded("base64"))

# POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageInvoice
http = Chilkat::CkHttp.new()
http.put_Accept("application/xml")
http.SetRequestHeader("Content-Type","application/xml")
endpoint = "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageInvoice"
# resp is a CkHttpResponse
resp = http.PostXml(endpoint,xml.getXml(),"utf-8")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code = " + resp.get_StatusCode().to_s() + "\n";

respXml = Chilkat::CkXml.new()
respXml.LoadXml(resp.bodyStr())
print "Response body:" + "\n";
print respXml.getXml() + "\n";

# The result looks like this:

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <ManageInvoiceResponse xmlns="http://schemas.nav.gov.hu/OSA/2.0/api" xmlns:ns2="http://schemas.nav.gov.hu/OSA/2.0/data">
#     <header>
#         <requestId>RID871830318143</requestId>
#         <timestamp>2020-03-25T15:51:25Z</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>2WT9GFSKFUU1V4XP</transactionId>
# </ManageInvoiceResponse>

# Use this online tool to generate parsing code from sample XML: 
# Generate Parsing Code from XML

ManageInvoiceResponse_xmlns = respXml.getAttrValue("xmlns")
ManageInvoiceResponse_xmlns_ns2 = respXml.getAttrValue("xmlns:ns2")
requestId = respXml.getChildContent("header|requestId")
timestamp = respXml.getChildContent("header|timestamp")
requestVersion = respXml.getChildContent("header|requestVersion")
headerVersion = respXml.getChildContent("header|headerVersion")
funcCode = respXml.getChildContent("result|funcCode")
softwareId = respXml.getChildContent("software|softwareId")
softwareName = respXml.getChildContent("software|softwareName")
softwareOperation = respXml.getChildContent("software|softwareOperation")
softwareMainVersion = respXml.getChildContent("software|softwareMainVersion")
softwareDevName = respXml.getChildContent("software|softwareDevName")
softwareDevContact = respXml.getChildContent("software|softwareDevContact")
softwareDevCountryCode = respXml.getChildContent("software|softwareDevCountryCode")
softwareDevTaxNumber = respXml.getChildContent("software|softwareDevTaxNumber")
transactionId = respXml.getChildContent("transactionId")

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.