RestFul API Einrichtung

API for raising and querying tickets in the Crout Control Center (CCC).

Die gesamte Doku finden Sie hier: https://ctde.nina.zygo.net/api/v1/guide/

Getting Started

You’ll need an account set up in the CCC portal before you will be able to use these APIs.

Please note that all provisioning request (i.e. Connect/Disconnect Service, Change Service Name or Add/Remove Bar) will create a CCC ticket for each SIM card. The CCC ticket handles your request (i.e. activations) and sends them to the network. If you activate only one or a few SIM cards the processing of these tickets takes a few minutes, but if you activate larger amounts of SIM cards it can also take hours until all SIM cards and the according tickets are handled. If you send another API request for a SIM card which has already a pending ticket, you will receive the error message „Service Locked. Another ticket is processing. / error code:101“. In this case you should wait until the already pending ticket is successfully handled.
You can check the status of your open tickets in the upper right corner of your CCC Portal. You will find notifications or here as well, if you click on the bell icon:

Request Structure

Parameters

Each API Method will have its own parameters. Unless stated otherwise each request should also contain two elements:

{
  "user": {
    "username": "...",
    "password": "..."
  },
  "service": {
    "code": "...",
    "cli": "...",
    "sim": "..."
  }
}

Params	Type	Required
user	object	true
user.username	string	true
user.password	string	true
service	object	true
service.code	string	At least one code or cli or sim
service.cli	string	At least one code or cli or sim
service.sim	string	At least one code or cli or sim

Endpoint for the API request: https://ctde.nina.zygo.net/api/v1/xxx

(substitute xxx by the individual Method, see below)

Method

The individual HTTP methods will be individually described in the following.

Description of individual HTTP methods:

. Get Contracts

List the Contracts belonging to a Customer.

The „Get Contracts“ method is used to retrieve the Contract Codes used for a specific Customer Code.  The retrieved CODE value(s) returned from „Get Contracts“ is needed as the „contractCode“ attribute for the „Connect Service“ method.

NOTE: Usually there is only one contract existing for one customer.

Example “Get Contracts” Request

POST /v1/getContracts

{
  "user": {
    "username": "MarioG",
    "password": "Stuttgart"
  },
  "customer": "1000000"
}

description of the parameters:

customer: The customer attribute should be populated with your Customer Account Number.  This is displayed next to your account in the Crout Control Centre (CCC) portal. 

Example “Get Contracts” Response (Success)

{
  "ok": true,
  "contracts": [
    {
      "CODE": "1000274",
      "NAME": "MarioG18",
      "ACTIVE_SERVICES": 217
    },
    {
      "CODE": "1900274",
      "NAME": "MarioG19",
      "ACTIVE_SERVICES": 11
    }
  ]
}

Example “Get Contracts” Response (Error)

{
  "ok": false,
  "errorCode": "209",
  "errorMessage": "'customer' missing."
}

2. Connect Service

Raise a ticket to connect a new service.

NOTE: You have first to retrieve the „contractCode“ value using the „Get Contracts“ method before you can call the „Connect Service“ method. 

Parameters:

These are in addition to the standard parameters.

NOTE: The service block is not required here

Params	Type	Required
sim	string	true
name	string	true
contractCode	string	true
tariffCode	string	true
APNCodes	string	false

Example “Connect Service” Request

POST /v1/connectService

{
  "user": {
    "username": "MarioG",
    "password": "Stuttgart"
  },
  "sim": "8910390000015161789",
  "contractCode": "200035680",
  "tariffCode": "TEASEU1000MB",
  "APNCodes": "AS_APN_CROUT",
  "name": "IMK Test"
}

description of the parameters:

sim: ICCID (SIM Number) that is to be activated

name: SIM Name (Service Username) for the SIM that is to be activated

contractCode: CODE value returned for the applicable customer account using the „Get Contracts“ method

tariffCode: The unique code for the product on which you wish to activate the SIM.  You can obtain a list of applicable values from the „Tariffs“ section of the „Selfcareable Products“ screen in the CCC portal.

APNCodes: The unique code for the APN(s) you wish to activate along with the SIM.  You can obtain a list of applicable values from the „APNs“ section of the „Selfcareable Products“ screen in the CCC portal.

Example “Connect Service” Response (Success)

{
  "ok": true,
  "ticket": {
    "id": "1226",
    "status": "Processing"
  }
}

Example “Connect Service” Response (Error)

{
  "ok": false,
  "errorCode": "208",
  "errorMessage": "'sim' missing."
}

3. Disconnect Service

Raise a ticket to disconnect an active service.

Parameters:

These are in addition to the standard parameters.

Params	Type	Required
newSIM	string	true