To retrieve your API key, login to the logicbroker portal. An API Key can be generated by going to Settings > API Authentication
\n\nPrimary key is generally for your internal use where as the secondary key can be shared with your 3rd party development or external resources.
\n\nAn API Key will need to be generated in the **Production portal:**https://portal.logicbroker.comas well as the **Stage portal:**https://stageportal.logicbroker.com
\n\nEvery request must have the API key as a URL query parameter (subscription-key).
\n\n# Understanding the Flow\n\nLogicbroker uses statuses to dictate document flow. Examples of order statuses are: New, Ready to be Acknowledged, Updating Address Information, Ready to Ship, Ready to Invoice, Complete etc. These statuses dictate when API calls need to be made to complete the order life cycle.\n\nThe documentation is grouped as follows:\n\n1. Retailers\n \n - Retailer Order LifeCycle\n \n - Retailer Inventory Process\n \n2. Suppliers\n \n - Supplier Order Life Cycle\n \n - Supplier Label Flows\n \n - Supplier Inventory Process\n \n3. Other System Data\n \n - Product Content\n \n - Activity Events and Error Handling\n \n - Webhooks\n \n\nThese sections will help you understand where to get needed data sets, when to request data, how to implement webhooks, when to update document statuses, and how to end-to-end test with trading partners.\n\n# Testing the Flow\n\nLogicbroker recommends using Postman for testing, as it lets you mimic API calls and view their response, before having write any code. Download postman [here](https://www.getpostman.com/apps)\n\nOn the top of this page, you will see a button that says “Run in Postman”. Clicking this will open postman, and copy the entire collection (with folders) into your Postman application. (Note: It will have the name “Retailer Order Lifecycle”, but will include all necessary flows).\n\nFollowing each step will persist the data to the next step, showing you the ideal process for order processing. To begin the test, you will need to enter your stage API Key as a variable. You can do this by clicking the following icon and then \"Edit\" next to environments.\n\nUpdate the highlighted **subscription-key** variable with your API Key and click **save**.\n\n