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

      Test swiftpos Admin API

      This outlines the information and steps that are needed when wanting to test the swiftpos Admin API using the available Test environment.

      The content and related topics are targeted at Resellers and 3rd Party Application (3PA) integrators who have a sound knowledge of and experience with swiftpos. For further information or assistance, please contact your swiftpos Reseller or swiftpos Support.

      Steps To Follow      ▼

      To Be Considered      ▲ ▼

      swiftpos Database      ▲ ▼

      To ensure the swiftpos Back Office database is in Test mode, select the Testing Database button in the Registration screen.

      URL      ▲ ▼

      The URL available for testing the swiftpos Admin API is https://api-test.swiftpos.com.au

      Notes...



      This URL is currently only valid for testing. Refer to Getting Started for information regarding the production URL.

      Http Header Change      ▲ ▼

      If previously the Local WebAPI was being used the the following will need to be considered:

      • The HTTP Header Key name will need to be changed from ApiKey to AuthorizationToken.

      API Call Change      ▲ ▼

      An API call must now include the URL above. For example:

      • A current API call using the local WebAPI may look something like this:
        http://127.0.0.1/WebAPI/api/Product
      • Based on the above, the same call using the swiftpos Admin API will then look like this:
        https://api-test.swiftpos.com.au/api/Product

      How To Test Using Swagger      ▲ ▼

      The following URL is available to test the swiftpos Admin API using Swagger:

      https://api-test.swiftpos.com.au/swagger/

      To test the swiftpos Admin API in a Test environment, the following credentials can be used to facilitate this:

      • "ClerkId": 0,
      • "ClientId": 670147,
      • "CustomerId": 66885289,
      • "Signature": "Swift-API-Demo",
      • "Identity": "bcc64087-9471-445a-9d93-6575502fb12c"

      Refer to SwiftPOS API (CLOUD) in the Reseller Help for more information.

      End of article.      ▲