This tutorial explains how to locate the BANK control API and where to find related documentation.
Before using the API, please note that all BRICKS APIs communicate in GraphQL format. You should have a basic understanding of GraphQL syntax before proceeding.
🕐 Estimated time to complete this tutorial: 2–3 minutes
Step 1: Go to the Manage Keys page in BANK
Click the [ BANK ] tab and then click [ Manage Keys ] at the bottom-left to enter the management page.
Step 2: Find the API link in Key Management
Click the [ ? ] icon on the right side of Key Management and look for the [ API Explorer ] link in the expanded text.
Before navigating to the API page, copy the code shown inside the curly brackets { }.
Step 3: Expand the HTTP HEADERS section on the API page
Click [ HTTP HEADERS ] at the bottom of the page, and in the expanded area, paste the code you copied in the previous step.
Step 4: Return to Controller and generate a key for API use
Click [ Generate Key used by Update Page ], and in the newly generated Key list, click [ Copy Key ] to copy the key.
Step 5: Replace Your_Key in the code with the copied key
In the code, locate [ YOUR_KEY ] and replace it with the key you copied in Step 4.
Note: Keep the quotation marks (" ").
Step 6: Review Doc and Schema on the API page
Click [ Doc ] on the right side of the page to check supported API functions, and click [ Schema ] to review the data structures.
Step 7: Start communicating with the Property Bank via API
You are now ready to use the BANK API to communicate with the Property Bank.
For details on API usage, refer to the [ Doc ] section. For information on data structures, refer to the [ Schema ] section.The next lesson will explain how to perform queries.
For any assistance, please click the chat icon in the bottom-right corner. Our team will respond to your questions as quickly as possible.