{
  "info": {
    "_postman_id": "apeiron-iot___data_sim",
    "name": "Apeiron API - IoT & Data SIM",
    "description": "Data-only / IoT SIM card management \u2014 LTE SIM and eSIM lifecycle, activation, suspension, deactivation, usage tracking, SIM/MSISDN swaps, service plans, and signal strength reports. Resources are identified by ICCID.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/",
    "version": "1.0.0",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "basic",
    "basic": [
      {
        "key": "username",
        "value": "{{username}}",
        "type": "string"
      },
      {
        "key": "password",
        "value": "{{api_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.apeiron.io",
      "type": "string"
    },
    {
      "key": "username",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_token",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "LTE SIM Card",
      "description": "LTE SIM Card endpoints",
      "item": [
        {
          "name": "Get list of LTE SIM cards of user",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/?page=&activated=&available=&suspended=&skus=&provider=&product_type=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "description": "Page number for the paginated version of the response, with 20 items per page",
                  "disabled": true
                },
                {
                  "key": "activated",
                  "value": "",
                  "description": "Filter by SIM cards by activated status, true or false",
                  "disabled": true
                },
                {
                  "key": "available",
                  "value": "",
                  "description": "Filter by SIM cards by available status, true or false",
                  "disabled": true
                },
                {
                  "key": "suspended",
                  "value": "",
                  "description": "Filter by SIM cards by suspended status, true or false",
                  "disabled": true
                },
                {
                  "key": "skus",
                  "value": "",
                  "description": "Only show SIM cards of the specified SKUs",
                  "disabled": true
                },
                {
                  "key": "provider",
                  "value": "",
                  "description": "Only show SIM cards of the specified provider",
                  "disabled": true
                },
                {
                  "key": "product_type",
                  "value": "",
                  "description": "Only show SIM cards of the specified product type",
                  "disabled": true
                }
              ]
            },
            "description": "Return list of LTE SIM cards belonging to the authenticated user, returns all entries unless page GET parameter is sent, and in that case the list of sim cards is present in data along with pagination related properties."
          }
        },
        {
          "name": "Get SIM Card Info",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}"
              ]
            },
            "description": "Return the basic information about a SIM card"
          }
        },
        {
          "name": "Update SIM Card label, cost center or service plan",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/update/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "update"
              ]
            },
            "description": "Update a SIM card's label or cost center fields, if provided, at least one of the two must be provided while making the request",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "label",
                  "description": "Label of the SIM card, optional, will only be updated if provided",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "cost_center_id",
                  "description": "ID of the cost center, optional, will only be updated if provided",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "service_plan",
                  "description": "Service plan for activation, optional, will only be updated if provided, change will be scheduled for the next billing cycle",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "override_pending",
                  "description": "If an existing service plan change was already requested, setting this to true allows to cancel the existing request and process a new service plan change, this will only allow for overriding till 7 hours before the end of current billing cycle. defaults to false",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "change_type",
                  "description": "Type of service plan change to be made, one of 'next_billing_cycle', 'backdate' or 'immediate', defaults to 'next_billing_cycle'",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Activate SIM Card",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/activate/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "activate"
              ]
            },
            "description": "Activate a SIM card in inventory",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "imei",
                  "description": "IMEI of device to activate",
                  "type": "text",
                  "value": "356526070520000"
                },
                {
                  "key": "service_plan",
                  "description": "Service plan for activation",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Suspend SIM Card",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/suspend/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "suspend"
              ]
            },
            "description": "Suspend a SIM card in inventory"
          }
        },
        {
          "name": "Restore Suspended SIM Card",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/restore/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "restore"
              ]
            },
            "description": "Restore a currently suspended SIM card"
          }
        },
        {
          "name": "Deactivate SIM Card",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/deactivate/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "deactivate"
              ]
            },
            "description": "Deactivate a SIM card in inventory"
          }
        },
        {
          "name": "Get recent usage",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/usage?page=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "usage"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "description": "Page number for the paginated version of the response, with 20 items per page",
                  "disabled": true
                }
              ]
            },
            "description": "Return the usage for the past 30 days for all SIM cards, returns all entries unless page GET parameter is sent, and in that case the list of usages is present in data along with pagination related properties."
          }
        },
        {
          "name": "Get recent usage for a specific SIM card",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/usage",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "usage"
              ]
            },
            "description": "Return the usage for the past 30 days for a specific SIM card"
          }
        },
        {
          "name": "Get usage for a specific day",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/usage/{usage_date}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "usage",
                "{usage_date}"
              ]
            },
            "description": "Return the usage for a specific day for all SIM cards"
          }
        },
        {
          "name": "Get usage for specific SIM card and specific day",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/usage/{usage_date}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "usage",
                "{usage_date}"
              ]
            },
            "description": "Return the usage for a specific day for a specific SIM card"
          }
        },
        {
          "name": "Get list of available plans to activate SIMs with or to change the service plan to for the customer",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/service_plans/list?page=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "service_plans",
                "list"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "description": "Page number for the paginated version of the response, with 20 items per page",
                  "disabled": true
                }
              ]
            },
            "description": "Return list of available plans to activate SIMs with or to change the service plan to for the customer, returns all entries unless page GET parameter is sent, and in that case the list of sim card plans is present in data along with pagination related properties."
          }
        },
        {
          "name": "Swap a SIM's ICCID and, optionally, IMEI",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/simswap/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "simswap"
              ]
            },
            "description": "Swap a SIM by ICCID or by ICCID and IMEI. IMEI cannot be swapped by itself.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "new_iccid",
                  "description": "The ICCID being swapped to.",
                  "type": "text",
                  "value": "89148000005689140000"
                },
                {
                  "key": "imei",
                  "description": "IMEI to swap alongside the ICCID.",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Swap a SIM's MSISDN",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/simcards/{iccid}/msisdnswap/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "simcards",
                "{iccid}",
                "msisdnswap"
              ]
            },
            "description": "Request a new MSISDN for a SIM.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "zip_code",
                  "description": "Zip code to use when assigning a non-Geo MSISDN, or when an NPA NXX for a Geo MSISDN is not available.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "npanxx",
                  "description": "The NPA NXX (area code and prefix) to use when assigning a Geo MSISDN. If a number starting with the NPA NXX is not available, zip code will be used as a fallback.",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Signal Strength Reports",
      "description": "Signal Strength Reports endpoints",
      "item": [
        {
          "name": "List signal strength reports",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/signal_strength_reports",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "signal_strength_reports"
              ]
            },
            "description": "Get a list of signal strength reports for the customer with the latest report data"
          }
        },
        {
          "name": "Get signal strength report history",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/signal_strength_reports/{report_code}/history",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "signal_strength_reports",
                "{report_code}",
                "history"
              ]
            },
            "description": "Get the complete history of signal strength measurements for a specific report"
          }
        }
      ]
    },
    {
      "name": "eSIM",
      "description": "eSIM endpoints",
      "item": [
        {
          "name": "Get activation code",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/esims/{iccid}/get_activation_code",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "esims",
                "{iccid}",
                "get_activation_code"
              ]
            },
            "description": "Retrieve a QR code used to activate an eSIM. The QR code will need to be displayed on another device or screen to be scanned."
          }
        }
      ]
    }
  ]
}