Interactive Documentation

Once basic API connectivity is confirmed, the easiest way to experiment with the APIs is to use the interactive Swagger documentation. It allows you to interact with the APIs and see how each endpoint behaves without writing code. Each server has its own Swagger documentation. Using your browser, access the interactive Swagger docs:

• On the Sandbox server – Sandbox Interactive Swagger Documentation
• On Your Library Training Server – Interactive Swagger^© documentation is available on the library’s Sierra training server at <<Base URL from Table 3>>/swagger/index.html. You should obtain the library’s permission before using any of their servers for testing since real order records will be created. Remember to clean up and delete any order records that were created during testing.

Enter your API Key and Secret (for the Sandbox server or from Table 2 for your library) in the two boxes at the top right of the Swagger© documentation home page and hit enter. This authenticates you and allows you to make API calls.

Figure 3: Swagger Client Key / Client Secret fields