GET STARTED

API - Admin API - How To

This outlines the information and steps that are needed when wanting to make use of the swiftpos Admin API.

The content is targeted at Resellers and swiftpos Venue Administrators 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      ▼

• What Is It?
• What Is Required?
• Obtain an Integrator ID
• Configure Venue Manager
• Obtain An Authorisation Token
• What To Consider?
• Test Using Swagger?
  

 

---

What To Consider?      ▲ ▼

• URLs
• HTTP Header Change
• API Call Change

 

URLs      ▲ ▼

The URLs for the swiftpos Admin API are:

• For Test - https://api-test.swiftpos.com.au
• For Production - https://api.swiftpos.com.au

The URLs to test swiftpos Admin API using Swagger are:

• For Test - https://api-test.swiftpos.com.au/swagger/
• For Production - https://api.swiftpos.com.au/swagger/

Refer HERE for more information.

 

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.swiftpos.com.au/api/Product

 

End of article.      ▲