It is recommended that all users familiarise themselves with the contents of the API documentation.
All pages of the API documentation are organised in a tree menu on the left-hand side of the screen:
The tree menu allows users to navigate all pages of the API documentation as a vertical list of nodes arranged in a tree-like structure. Each node represents a page, displayed as an indented menu option. The indentation indicates hierarchical levels. A node can be expanded to reveal subitems and collapsed to hide subitems:
Some ‘parent' pages in the API documentation contain a list of 'children’ pages, as per the following:
The top of every page in the API documentation contains a table of contents, as per the following:
3. Supplementary information
Any additional information that is purely meant for additional detail in included in the “Supplementary Information“ section.
The “Reference” section contains reference material that is referred to in several places in the API documentation. Reference material includes, amongst other things, the following:
A complete ISO 3166-1 encoding list of the countries which are assigned official codes.
A complete ISO 4217 encoding list of alphabetic codes and numeric codes for the representation of currencies.
5. Using the glossary
5.1. About the glossary
The “Glossary” app is currently unavailable as a standalone app. Kindly use the Dictionary page (Reference > Dictionary) for the time being.
The API documentation contains a useful glossary of technical and financial terminology.
The glossary is accessed using the “Glossary” menu option under the “Apps” section on the left-hand panel:
Clicking on the “Glossary” menu option opens up the “Glossary” app:
Glossary terms may be found using the “search” field or the list of glossary terms may be refined using the “filter” option.
The list of glossary terms may be organised in a particular sequence using the “order by” function.
5.2 Using the glossary within API documentation pages
The use of the “Glossary” app within the API documentation pages (i.e., embedded) is currently operational.
The “Glossary” app of the API documentation is a powerful term and definition management system that includes an intuitive content highlighting engine.
Within any page of the API documentation, simply click on the glossary button, at the top right-hand side of the page:
An overlay will then be loaded on top of the page, with certain technical terms in the text being highlighted in yellow, as per the following sample:
Clicking on a highlighted term will load the definition in a panel on the right-hand side of the page:
The data in the right-hand panel typically includes one or more of the following items (as per the image below):
Clicking on the ‘Close' button (i.e., white 'x’ on blue background) at the top of the definition panel will close the definition panel.
Then, clicking on the ‘Close' button (i.e., white 'x’ on black background) in the black band at the very top of the overlay will close the overlay.