NexCon.io Rest API (1.0)

Download OpenAPI specification:Download

This documents the public REST API for NexCon.io.

In order to get started, please log in to your NexCon.io account and generate an API key. You can do this by going to the NexCon.io dashboard and click "API Access" in the bottom left corner and then follow the on-screen instructions

We recommend that you also whitelist the IP addresses you intend to communicate from. This will further secure your account against other people using your API key.

To communicate with the API, you need to send the API key in the Authorization header, prefixed with the bearer keyword. The API key is a string that looks like this: AbCdEf_H4V1eTH0LSV1wDY98YfL6GSmLX

Thus, a complete REST API call would look like this:

POST /api/v1/simcard/status HTTP/1.1
Host: app.nexcon.io
Authorization: bearer AbCdEf_H4V1eTH0LSV1wDY98YfL6GSmLX
Content-Type: application/json; charset=utf-8

{"icc":"89450000000000123456"}

You will then receive a response in JSON. All successful calls will use status code 200. If the call was not successful, you will receive a status code in the 400 range, as per the individual endpoint documentation below.

Note that you should prefix all API calls with /api/v1/TYPE/, where TYPE is the sub-area you are working with, eg. SIM cards would be simcard. This is the current version of the API. We will increment this number if we make breaking changes to the API.

SimCard

/activate

Authorizations:
ApiKey
Request Body schema: application/json
required
icc
required
string

The sim ID of the SIM Card

callbackUrl
string

URL that will be called to, when the job finished

Responses

Request samples

Content type
application/json
{
  • "icc": "string",
  • "callbackUrl": "string"
}

/terminate

Permanently terminates the SIM Card. This request is irreversible

Authorizations:
ApiKey
Request Body schema: application/json
required
icc
required
string

The ICC number of the SIM Card

callbackUrl
string or null

URL that will be called to, when the job finished

Responses

Request samples

Content type
application/json
{
  • "icc": "string",
  • "callbackUrl": "string"
}

/restore

Authorizations:
ApiKey
Request Body schema: application/json
required
icc
required
string

The sim ID of the SIM Card

callbackUrl
string or null

URL that will be called to, when the job finished

Responses

Request samples

Content type
application/json
{
  • "icc": "string",
  • "callbackUrl": "string"
}

/block

Authorizations:
ApiKey
Request Body schema: application/json
required
icc
required
string

The sim ID of the SIM Card

callbackUrl
string or null

URL that will be called to, when the job finished

Responses

Request samples

Content type
application/json
{
  • "icc": "string",
  • "callbackUrl": "string"
}

/status

Authorizations:
ApiKey
Request Body schema: application/json
required
icc
required
string

The sim ID of the SIM Card

Responses

Request samples

Content type
application/json
{
  • "icc": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "tags": [
    ],
  • "countryCode": "string",
  • "msisdn": "string",
  • "product": {
    },
  • "pool": {
    }
}