At this point, you should have a basic understand of the Spire API concepts. Remember that these concepts do not change, regardless of the tools you are using. Whether you are using a full programming environment, building OOP structures, and intending to create a complex compiled and distributed application, or you are trying to solve a simple problem – the Spire API remains the same. We have seen;
- That the API browser is a built in application you access with a web browser. This helps you visualize the available fields in the API
- That collections represent groups of items of a like kind (customer, sales, inventory). You POST to a collection to add items
- That specific endpoints represent entities in Spire. That might be a General Ledger account, a customer or a sales history invoice
- That HTTP verbs (POST, PUT, DELETE, GET) determine the action you want to take
- Some actions expect a payload (Json representation of data) and use that to make a change or addition
- That the Spire API server response is useful, and contains information regarding the action taken (success or failure, status information and more).
What follows is a “cookbook” section. Here, many examples are provided that show you some of the things you might want to do with the API. Check back here, as the intention is to grow this list as additions to the Spire API functionality are made, and user feedback is received. Please, don’t jump ahead to the cookbook section until you have been successful in the examples in the course. Topics in the cookbook assume you have completed the examples provided in the course chapters.