API

What is Postman and why should I use it?

Postman is a popular API development tool that allows you to create, share, test, and document APIs. It provides a user-friendly interface to send HTTP requests and view responses, making it easier to interact with APIs like those provided by SFT.

How do I set up Postman to use the SFT APIs?

To get started with Postman and the SFT APIs, follow these steps:

1. Download and Install Postman: You can download Postman from the https://www.postman.com/downloads/ .

2. Create a New Request: Open Postman and click on "New" to create a new request.

3. Set the Request URL: Enter the SFT API endpoint URL, for example, https://api.sft.bics.com/api/login.

4. Select the HTTP Method: Choose the appropriate HTTP method (GET, POST, etc.) based on the API documentation.

How do I authenticate with the SFT API?

Before making any API calls, you need to authenticate yourself and obtain an access token. Here’s how:

1. Set the URL: Use the endpoint https://api.sft.bics.com/api/login.

2. Select POST Method: Choose the POST method.

3. Set Headers: Add the following headers:

   • Content-Type: application/json

   • X-Requested-With: XMLHttpRequest

4. Set Body: In the Body tab, select raw and JSON format, then enter your credentials:

5. Send Request: Click "Send" to receive the access token in the response.

How do I use the access token for subsequent API calls?

Once you have the access token, you need to include it in the headers of your subsequent API requests:

1. Set Headers: Add the following header to your request:

   • Authorization: Bearer <Your Access Token>

2. Example: For a GET request to fetch SIM details:

   • URL: https://api.sft.bics.com/api/fetchSIM

   • Method: GET

   • Headers:

     • Authorization: Bearer <Your Access Token>

How do I retrieve different IDs required for API calls?

To retrieve various IDs such as APN group ID, Plan ID, and Roaming Profile ID, follow these steps:

1. APN Group ID: Use the endpoint https://api.sft.bics.com/api/GetAPNGroup.

2. Plan ID and Roaming Profile ID: Use the endpoint https://api.sft.bics.com/api/GetPlans.

3. Available SIMs: Use the endpoint https://api.sft.bics.com/api/GetAvailableSIMs.

How do I create an endpoint using the SFT API?

To create an endpoint, follow these steps:

1. Authentication: Ensure you have authenticated and have the access token.

2. Set URL: Use the endpoint https://api.sft.bics.com/api/CreateEndpoint.

3. Select POST Method: Choose the POST method.

4. Set Headers: Add the Authorization header with your access token.

5. Set Body: In the Body tab, select raw and JSON format, then enter the required parameters:

6. Send Request: Click "Send" to create the endpoint.

Where can I find detailed API documentation?

You can find detailed API documentation and examples on the SFT API documentation page.

Can I use an ICCID to execute API requests?

An ICCID is one of the key identifiers which can be used to fetch the endpointID of a device and all the associated information with the help the following API.

https://sft.bics.com/api/fetchSIM?iccid=100000000000000000

Since an endpoint represents an actual device, the majority of APIs use the endpointID as the key to trigger operations. To know more about endpoints and why it can be useful to know their details, please check. https://docs.sft.bics.com/sft/what-is-an-endpoint-and-why-do-i-need-to-create-on