Rundaz Logo HostMy® API

Getting Started with HostMy™ API

1.
Open the Console Web Application
HostMy® API Console ⇢
2.
Register as a HostMy® API User
a.
Register a Valid Email Address with HostMy® API
b.
Retrieve the Emailed Registration Code
c.
Create a HostMy® API User Account using the Emailed Registration Code
d.
Logon to the HostMy® API Console
e.
Logout of the HostMy® API Console
3.
Creating and Retrieving Data
a.
Download the JSON Product Catalogue (ProductCatalogue-2024-Q2.json) Download Product Catalogue
b.
Create the User Organisation Hierarchy - See Organisation Hierarchy Explained(Opens a new tab)
c.
Create an ADMIN and READONLY Access Key
d.
Upload the JSON Product Catalogue
e.
Retrieve the JSON Product Catalogue from Shell Console using CURL
f.
Retrieve CURL Statement URL including Key from API History
g.
Defining a default key to make data Universally Available without Key
h.
Retrieving a single record
4.
Fetching Data using APIs
a.
Download the FetchDataTutorial Java Program FetchDataTutorial.java
b.
Compile the FetchDataTutorial Java Program E.g. javac FetchDataTutorial.java
c.
Execute the FetchDataTutorial Java Program E.g. java FetchDataTutorial
d.
Download the FetchRecordTutorial Java Program FetchDataTutorial.java
e.
Compile the FetchRecordTutorial Java Program E.g. javac FetchRecordTutorial.java
c.
Execute the FetchRecordTutorial Java Program E.g. java FetchRecordTutorial
5.
Maintain a Data Document using APIs
a.
Create new DaysOfWeek Branch in the existing /<Your Org>/Live/Sales Hierarchy using the HostMy® API Console ⇢
a1.
Create a new DaysOfWeek Dataset Hierarchy Element on the Sales Scope
a2.
Create a new Version Hierarchy Element on the new DaysOfWeek Dataset
a3.
Create a DayOfWeekAdmin Key with full Read, Write and Delete privileges to the DaysOfWeek Dataset Version
a4.
Review at the Editor Area to see there is no data
b.
Create a new Document against the DaysOfWeek Version Hierarchy Element
b1.
Download the CreateDocumentTutorial Java Program CreateDocumentTutorial.java and supporting data file WorkDaysData_v01.json
b2.
Compile the CreateData Java Program E.g. javac CreateDocument.java
b3.
View the DaysOfWeek Dataset Version and assign the DayOfWeekAdmin Key. N.B. Copy the TABLE URL and KEY ID for later use
b4.
Execute the CreateData Java Program E.g. java CreateData <TABLE URL> <KEY ID>
b4.
Click the Load Button above the Editor Area and note the Week Day Records in the new document
c.
Append New Records to the existing DaysOfWeek Document
c1.
Download the AppendRecordsTutorial Java Program AppendRecordsTutorial.java and supporting data file Weekend_v01.json
c2.
Compile the AppendRecordsTutorial Java Program E.g. javac AppendRecordsTutorial.java
c3.
Execute the AppendRecordsTutorial Java Program E.g. java AppendRecordsTutorial <TABLE URL> <KEY ID>
c4.
Click the Load Button above the Editor Area and note new DaysOfWeek Saturday and Sunday records have been appended to the data
VIDEO
d.
Replace the existing DaysOfWeek Document with an English and German DaysOfWeek Document
d1.
Download the ReplaceDocumentTutorial Java Program ReplaceDocumentTutorial.java and supporting data file Weekdays_en_de_v01.json
d2.
Compile the ReplaceDocumentTutorial Java Program E.g. javac ReplaceDocumentTutorial.java
d3.
Execute the ReplaceDocumentTutorial Java Program E.g. java ReplaceDocumentTutorial <TABLE URL> <KEY ID>
d4.
Click the Load Button above the Editor Area and note that the DaysOfWeek Document now has English and German entries
VIDEO
e.
Update a record within the DaysOfWeek Document
e1.
Download the UpdateRecordTutorial Java Program UpdateRecordTutorial.java and supporting data file UpdateRecord_v01.json
e2.
Compile the UpdateRecordTutorial Java Program E.g. javac UpdateRecordTutorial.java
e3.
Execute the UpdateRecordTutorial Java Program E.g. java UpdateRecordTutorial <TABLE URL> <KEY ID>
e4.
Click the Load Button above the Editor Area and note that the incorrect record has been corrected
VIDEO
6.
Security
7.
URL Alias
8.
Budgets