CalcConfigurations

Order system configurations and items

Get all shop categories

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRequired

ID of a category

namestringRequired

Name of a category

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/calc/categories

HTTPcURLJavaScriptPython

GET /v3/calc/categories HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text"
  }
]

Get all configurations for the given shop category

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

categoryNamestringRequired

Category name, one of /calc/categories

Responses

200

OK

application/json

idinteger · integerRequired

ApplicationInstanceConfiguration ID

taginteger · integerRequired

ApplicationInstanceConfiguration tag

locationIdinteger · integerRequired

Location ID, as provided by /locations

priceinteger · integerRequired

ApplicationInstanceConfiguration price in cents

setupinteger · integerRequired

ApplicationInstanceConfiguration setup price in cents

flagsinteger · integerRequired

ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;

bwPriceDediinteger · integerRequired

TB price for dedicated servers, in cents

bwPriceColointeger · integerRequired

TB price for colocation, in cents

fixedbooleanRequired

Whether this configuration is adjustable

noDowngradebooleanRequired

Whether items in this configuration can be downgraded

instantDeliverablebooleanRequired

Whether this configuration can be setup instantly and automatically (low wait time)

403

Invalid credentials

404

If an unknown category has been provided

500

Internal Server Error

application/json

get

/v3/calc/configs/{categoryName}

HTTPcURLJavaScriptPython

GET /v3/calc/configs/{categoryName} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "tag": 1,
    "locationId": 1,
    "price": 1,
    "setup": 1,
    "flags": 1,
    "bwPriceDedi": 1,
    "bwPriceColo": 1,
    "fixed": true,
    "noDowngrade": true,
    "instantDeliverable": true,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "code": "text",
        "type": "text",
        "fixed": true,
        "step": 1,
        "flags": 1,
        "noDowngrade": true,
        "displayOrder": 1,
        "dependencyGroupId": 1,
        "dependencyItemIds": [
          1
        ],
        "notes": "text",
        "items": [
          {
            "id": 1,
            "code": "text",
            "name": "text",
            "shortName": "text",
            "ident": "text",
            "quantity": 1,
            "specifications": [
              {
                "id": 1,
                "name": "text",
                "value": "text",
                "dataType": "text",
                "mandatory": 1
              }
            ],
            "flags": 1,
            "price": 1,
            "setupPrice": 1,
            "priceLinkGroupId": 1,
            "priceLinkPercentage": 1,
            "displayOrder": 1,
            "excludeConfigs": [
              1
            ],
            "excludeLocationIds": [
              1
            ]
          }
        ],
        "defaultItemId": 1
      }
    ]
  }
]

Get all groups and items of the given category

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

categoryNamestringRequired

Category name, one of /calc/categories

Responses

200

OK

application/json

idinteger · integerRequired

ApplicationInstanceConfiguration group ID

namestringRequired

ApplicationInstanceConfiguration group name

codestringRequired

ApplicationInstanceConfiguration group code

typestringRequired

ApplicationInstanceConfiguration group type (a human readable unique identifier)

fixedbooleanRequired

Whether items in this configuration group are adjustable

stepinteger · integerRequired

ApplicationInstanceConfiguration group divider (for visual differentiation between related groups)

flagsinteger · integerRequired

FLAG_HASQUANTITY 1 FLAG_HASPRICE 2 FLAG_ALLOW_EMPTY_SELECTION 4 FLAG_INCLUDE_ON_INVOICE_IF_EMPTY 8 FLAG_NOTE_ACTIVE 16 FLAG_APPLY_PERIOD_DISCOUNT 32 FLAG_EXCLUDE_FROM_UPGRADES 64

noDowngradebooleanRequired

Whether items in this configuration group can be downgraded

displayOrderinteger · integerRequired

ApplicationInstanceConfiguration group display order

dependencyGroupIdinteger · integerRequired

If > 0, this group will only relevant / shown if the dependency group and/or item is selected.

dependencyItemIdsinteger · integer[]Required

If dependencyGroupId > 0, this group will only relevant / shown if (one of) these dependencyItemIds are selected.

notesstringRequired

Optional notes for a group, for displaying purposes.

defaultItemIdinteger · integerRequired

Default item in a group

403

Invalid credentials

404

If an unknown category has been provided

500

Internal Server Error

application/json

get

/v3/calc/items/{categoryName}

HTTPcURLJavaScriptPython

GET /v3/calc/items/{categoryName} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "code": "text",
    "type": "text",
    "fixed": true,
    "step": 1,
    "flags": 1,
    "noDowngrade": true,
    "displayOrder": 1,
    "dependencyGroupId": 1,
    "dependencyItemIds": [
      1
    ],
    "notes": "text",
    "items": [
      {
        "id": 1,
        "code": "text",
        "name": "text",
        "shortName": "text",
        "ident": "text",
        "quantity": 1,
        "specifications": [
          {
            "id": 1,
            "name": "text",
            "value": "text",
            "dataType": "text",
            "mandatory": 1
          }
        ],
        "flags": 1,
        "price": 1,
        "setupPrice": 1,
        "priceLinkGroupId": 1,
        "priceLinkPercentage": 1,
        "displayOrder": 1,
        "excludeConfigs": [
          1
        ],
        "excludeLocationIds": [
          1
        ]
      }
    ],
    "defaultItemId": 1
  }
]

Get all the availability locations per calc category

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

categoryIdsinteger · integer[]Required

Category IDs

locationIdinteger · integerRequired

Location ID

countryNamestringRequired

Name of the country of this location

countryNameShortstringRequired

Name of the country of this location

regionIdinteger · integerRequired

Region ID

regionNamestringRequired

Name of the region this location is situated in (regions are smaller than continents, but may be a whole continent).

continentstringRequired

Name of the continent of this location

citystringRequired

Name of the city of this location

locationBwPriceDediinteger · integerRequired

Dedicated server bandwidth price per TB for this location, in cents

locationBwOverusePriceDediinteger · integerRequired

Dedicated server bandwidth overuse price per TB for this location, in cents

locationBwPriceColointeger · integerRequired

Colocation bandwidth price per TB for this location, in cents

locationBwOverusePriceColointeger · integerRequired

Colocation bandwidth overuse price per TB for this location, in cents

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/calc/locations

HTTPcURLJavaScriptPython

GET /v3/calc/locations HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "categoryIds": [
      1
    ],
    "locationId": 1,
    "countryName": "text",
    "countryNameShort": "text",
    "regionId": 1,
    "regionName": "text",
    "continent": "text",
    "city": "text",
    "locationBwPriceDedi": 1,
    "locationBwOverusePriceDedi": 1,
    "locationBwPriceColo": 1,
    "locationBwOverusePriceColo": 1
  }
]