User Guide

This section is intended to describe how to call the SwiftFederation Base APIs.

1. Customer APIs

1.1. Get Self Customer

If you don't know your customer id, you can call this API to get customer itself, which is based on access key. It means which customer access keys belongs to, it will return which customer.

Refer to Get Customer

API URL:

https://base-api.swiftfederation.com/v1.1/customer

1.2. Get Self Customer Children

If you don't know your customer id, you can still call this API to get customer children, which is based on access key. It means which customer access keys belongs to, it will return which customer's children list.

Refer to Get Customer Children

API URL:

https://base-api.swiftfederation.com/v1.1/customerChildren

1.3. Get Special Customer

It will return a customer according to customer id.

Refer to Get Customer

API URL:

https://base-api.swiftfederation.com/v1.1/customer/${customerId}

1.4. Get Special Customer Children

It will return customer's children list according to customer id.

Refer to Get Customer Children

API URL:

https://base-api.swiftfederation.com/v1.1/customerChildren/${customerId}

1.5. Create Customer

It will create a customer.

Refer to Create Customer

API URL:

https://base-api.swiftfederation.com/v1.1/createCustomer

1.6. Delete Customer

It will delete customer according to customer id.

Refer to Get Customer Children

API URL:

https://base-api.swiftfederation.com/v1.1/deleteCustomer/${customerId}
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2018-12-21 15:41:58

results matching ""

    No results matching ""