How To
      Back to home
      1. Swiftpos Help Guides
      2. API
      3. How To

      Swagger Testing / Diagnosing

      API - How To

       

      Subjects      ▼

       

      How Is It Accessed?      ▲ ▼

      It can be accessed by adding the /Swagger/UI/index suffix to the swiftpos API URL configured. For example, localhost/SwiftAPI/Swagger/UI/index.

       

      How Is It Used?      ▲ ▼

      Get An API Authorisaction Key

      • All SwiftAPI calls require an API authorisation key, ApiKey. To obtain one:
        • Select Authorisation and then Get
        • Populate the Parameter Values with the correct data and then select the Try it out button to execute the Get call.
        • Copy the API Key that is generated. This will be required to be pasted into the Value of the ApiKey Parameter when testing other SwiftAPI calls.

       

      Test API Calls      ▲ ▼

      • Select the Call to be tested and paste the API Authorisation Key obtained above into the ApiKey parameter and complete the rest of the parameters.
      • Select the Try it out button to execute the Get call.
      • Scroll up to the top of the section for an explanation of the response code returned.

       

      Notes ...


      Single Transaction Sales mode can not be used when Web store ordering or Deposit Media are used.

       

      What Is It?      ▲ ▼

      Swagger is a testing and diagnostic tool that comes with the swiftpos Admin API.

       

      End of article.      ▲