Generating OAuth 2.0 token

The OAuth 2.0 authorization code grant will be used by customer to gain access to protected resources, such as APIs. This set of APIs shall allow user to generate Access Token and refresh Access Token to perform any action on CMP via the API gateway.

Request an Access Token

To get a token by using the client Id & Client Secret, send a POST request to the /developer/generate/authtoken

Sample Request

curl -X POST "https://openapi.airtel.in/iot/api/developer/generate/authtoken"
         -H "accept: application/json"
         -H "apikey: XXXXXXXXXXXXXXXXXXXXXX"
         -H "iv-user: XXXXXXXXXXXXXXXXXXXXXX"
         -H "Content-Type: application/x-www-form-urlencoded"
         -d "client_id=XXXXXXXXXXXXXXXXXXXXXX&client_secret=XXXXXXXXXXXXXXXXXXXXXX"
       

Sample Response

{
           "data": {
             "refresh_token": "XXXXXXXXXXXXXXXXXXXXXX",
             "token_type": "bearer",
             "access_token": "XXXXXXXXXXXXXXXXXXXXXX",
             "expires_in": 1800
           }
         }
         

• Navigate to Documentation → Account Authorization → Generate Access Token → Test Endpoint
• Put values of apikey, client_id, client_secret, iv-user in mentioned text fields from Dashboard
• Make API Call.

Fetch SIM Inventory

This API shall allow user to fetch the details of SIMs on that Customer Account. It can fetch the details of one or more SIMs at a time.

Sample Request

curl -X GET "https://openapi.airtel.in/iot/api/customer/details/basket/0/sims
       ?pageNo=1&pageSize=1&simStatus=INITIAL"
       -H "accept: application/json"
       -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXX"
       -H "apikey: XXXXXXXXXXXXXXXXXXXXXX"
       -H "customer-id: XXXX"
       -H "iv-user: XXXXXXXXXXXXXXXXXXXXXX"
     

Sample Response

{
       "data":
       {
         "sims": [
         {
           "simId": "5165173",
           "mobileNo": "51967694502",
           "simNo": "9999000000000000000",
           "imsi": "30811010404043400",
           "lsi": " ",
           "status": "INITIAL",
           "isPaired": "0",
           "isPrepaidSim": "0",
           "circleName": "DELHI",
           "planCode": "M2M_PLN_0324",
           "planName": "VTS 49 special plan(without voice with sms)",
           "description": "VTS 49 special plan(without voice with sms)",
           "dataType": "2G",
           "dataUnits": "250",
           "planType": "0"
         }
         ],
         "total": "10000"
       }
     }
     

• Navigate to Documentation → Manage SIMs → Fetch SIMs → Test Endpoint
• Replace Bearer Token from access token generated from Generating OAuth 2.0 token
• Put values of apikey, iv-user & customer-id in mentioned text fields from Dashboard.
• Select simStatus as INITIAL
• Make API Call.

Fetch Plans

This API shall allow user to fetch the details of Plans that are associated with the Customer Account. It returns the Plan code, plan name, plan description and whether it is a test plan or actual plan as defined on the account.

Sample Request

curl -X GET "https://openapi.airtel.in/iot/api/customer/details/plans"
         -H "accept: application/json"
         -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXX"
         -H "apikey: XXXXXXXXXXXXXXXXXXXXXX"
         -H "customer-id: XXXX"
         -H "iv-user: XXXXXXXXXXXXXXXXXXXXXX"
       

Sample Response

{
         "data": [
         {
           "planCode": "M2M_PLN_0001",
           "planName": "M2M-2G-1GB PLAN",
           "planDescription": "M2M-2G-1GB PLAN",
           "testPlan": false
         },
         {
           "planCode": "M2M_PLN_0003",
           "planName": "M2M 3G - 100 MB PLAN",
           "planDescription": "M2M 3G - 100 MB PLAN",
           "testPlan": true
         }
         ]
       }
     

• Navigate to Documentation → Account Details → Fetch Customer Plans → Test Endpoint
• Replace Bearer Token from access token generated from Generating OAuth 2.0 token
• Put values of apikey, iv-user & customer-id in mentioned text fields from Dashboard.
• Make API Call.

Perform Activation

This API shall allow user to change the state of SIM from Available (Initial to Activate) to Active with Plan that is associated with the Billable account. It requires inputs as mobile number and plan code.

Sample Request

curl -X POST "https://openapi.airtel.in/iot/api/om/job/sim/activate"
         -H "accept: application/json"
         -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX"
         -H "apikey: XXXXXXXXXXXXXXXXXXXXXXXXX"
         -H "customer-id: XXXX"
         -H "iv-user: XXXXXXXXXXXXXXXXXXXXXXXXX"
         -H "Content-Type: application/json"
         -d "{ \"simDOList\": [ { \"mobileNO\": \"51967694502\",
         \"planDO\": { \"planCode\": \"M2M_PLN_0001\" } } ]}"
       

Sample Response

{
       "data": {
           "jobId": 795405,
           "jobType": "ACTIVATE_SIM",
           "orderCount": 0,
           "successCount": 0,
           "failureCount": 0,
           "inProgressCount": 0,
           "rejectedCount": 0,
           "orderInitiateDate": "25-04-2019 03:35:40 PM",
           "statusMessage": "Your request is in progress"
       }
   }
   

• Navigate to Documentation → New Orders → Activate Sim → Activate Sim → Test Endpoint
• Replace Bearer Token from access token generated from Generating OAuth 2.0 token
• Put values of apikey, iv-user & customer-id in mentioned text fields from Dashboard.
• Put mobileNo in body fetched from response of API Fetch SIM Inventory
• Put planCode in body fetched from response of API Fetch Plans
• Make API Call.

NOTE
The JobId in the response is important to track the status of activation order. The details of JobId can be fetched from Fetch Jobs API. There shall be Order ID(s) within a JobId to view status of specific Order(s) in a JobId.