Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

1NCE General SIMs API

General SIM Management

1NCE General SIMs API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include General SIMs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 12 operations across 9 paths, and defines 22 schemas. It is described by OpenAPI 3.0.1, at version v2.1.1.

Requests are made against a single base URL, https://api.1nce.com/management-api.

12 operations 9 paths 22 schemas 8 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.1.1
Server
https://api.1nce.com/management-api
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

1NCE General SIMs API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication).

  • BasicAuthentication — Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 8 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

General SIMs 12

General SIM Management

GET
/v1/sims
Get All SIMs
getSimsUsingGET 4 params → 200401403404422
POST
/v1/sims
Create Multiple SIM Configuration
updateSimsUsingPOST body → 201401403404422
GET
/v1/sims/{iccid}
Get Single SIM
getSimUsingGET 1 param → 200401403404422
PUT
/v1/sims/{iccid}
Create Single SIM Configuration
updateSimUsingPUT 1 param body → 200401403404422
GET
/v1/sims/{iccid}/status
Get SIM Status
getStatusForSimUsingGET 1 param → 200401403404422
POST
/v1/sims/simTransfer
Create SIM Transfer
simTransferUsingPOST body → 201401403404422
GET
/v2/sims
Get All SIMs
getSimsUsingGET 4 params → 200404500
GET
/v2/sims/{iccid}
Get Single SIM
getSimUsingGET 1 param → 200404500
PUT
/v2/sims/{iccid}
Modify SIM card
updateSimUsingPUT 1 param body → 200400404409500
GET
/v2/sims/{iccid}/quota/data
Get SIM Data Quota
getDataQuotaForSimUsingGET 1 param → 200404500
GET
/v2/sims/{iccid}/quota/sms
Get SIM SMS Quota
getSmsQuotaForSimUsingGET 1 param → 200404500
GET
/v2/sims/{iccid}/status
Get SIM Status
getStatusForSimUsingGET 1 param → 200400404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SimsPdpContext (35 properties), PdpContext (27 properties), SIM_card (16 properties), SimsSim (16 properties). Each schema is shown below with its type and property counts.

NotFound
object
Not found Error
3 properties 3 required
Values_for_a_SIM_update
object
Information about a SIM card based on a SIM update procedure.
4 properties 2 required
Quota_Status
object
Indicates whether more than 20%, less than 20% or 0% of the current quota SMS or data are still available.
4 properties
SIM_card
object
Detailed information about a SIM card.
16 properties
SimsConnectivityDetail
object
Information about the current SIM connectivity status, location and PDP Context of a SIM.
5 properties 2 required
SimsSimQuotaStatus
object
Indicates whether more than 20%, less than 20% or 0% of the current quota SMS or data are still available.
4 properties
IccidRange
object
2 properties
BadRequest
object
Validation Error
3 properties 3 required
SimsQuota
object
11 properties
SimsQuotaStatus
object
- 0 - "EXHAUSTED" - 1 - "ACTIVE" - 2 - "EXPIRED"
2 properties
InternalServerError
object
Internal Server Error
3 properties 3 required
SimsPdpContext
object
Information about the current PDP Context of the SIM.
35 properties 31 required
SimsConnectivityStatus
object
The current connectivity status of a SIM.
1 property 1 required
SimTransfer
object
Request data for transferring SIMs from one customer account to another.
3 properties
PdpContext
object
Information about the current PDP Context of the SIM.
27 properties
SimsDataTrafficLimitState
object
Data traffic limit state of the SIM
1 property 1 required
Connectivity
object
Information about the current SIM connectivity status, location and PDP Context of a SIM.
4 properties
Conflict
object
Conflict HTTP Status 409
3 properties 3 required
SimsLocation
object
14 properties 2 required
SimsSimUpdateReq
object
Information about a SIM card based on a SIM update procedure.
4 properties
Location
object
Location information of the SIM device.
14 properties
SimsSim
object
Detailed information about a SIM card.
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1nce-general-sims-api-openapi.yml Raw ↑

Other APIs 1NCE publishes across the network.

1NCE Administration Logs API
1NCE Agreements API
1NCE Bearer Authorization API
1NCE Connectivity API
1NCE Device Inspector API
1NCE Device Locator API
1NCE Devices API
1NCE IoT Integrator API
1NCE Optimizer API
1NCE Orders API
1NCE Plugin system API
1NCE Products API