ziqcloud-logo-v2.png
Documentation Powered by ReDoc

Ziqcloud Partner API v2 (1.5.0)

Download OpenAPI specification:Download

License: Apache 2.0

Ziqcloud Partner API v2 is partner API for interaction with Ziqcloud services.

Authentication

To use Partner API, use partner API keys generated by the Ziqcloud team.

Partner is provided with two keys with different roles:

  • User
  • Finance

Authentication into the system is provided by a token defined in the Authorization request title with value Bearer <token>. For example:

  -H "Authorization: Bearer 3CC...1F"

Endpoint:

  https://apipartner.ziqcloud.com

Accounts

User account information

List

Returns a list of all accoutns
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create

Create a new account
Available for the User role

Request Body schema: application/json
Email
required
string

Account email

State
required
string
Enum: "NotActivated" "Active"

New account state:
NotActivated – an activation link is sent to the account
Active – account will be created in the Active state

object

Responses

Request samples

Content type
application/json
{
  • "Email": "email@mail.com",
  • "State": "NotActivated",
  • "AdditionalData":
    {
    }
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get by ID

Returns one account by its ID
Available for the User role

path Parameters
id
required
string

Account ID for which details are needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Delete by ID

Deletes an account by its ID
You can delete an account meeting the following conditions:

  • Account has only a personal project and is not involved into shared projects
  • Balance of the personal project is zero or negative
  • Personal project does not have active services. For example, a project should not have active, blocked, or servers awaiting payment, networks, SSL certificates, DNS, or incompleted support requests, etc.
Available for the User role

path Parameters
id
required
string

Account ID to be deleted

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Projects

User's project contains all information about the balance and ordered services: active, blocked servers, and servers awaiting payment, networks, SSL certificates, DNS, etc.

List

Returns a list of all projects
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get by ID

Returns project details by the project ID
Available for the User role

path Parameters
id
required
integer <int32>

Project ID for which details are needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Edit

Changes a project by its ID
Available for the User role

path Parameters
id
required
integer <int32>

Project ID to be edited

Request Body schema: application/json
IsPostPaid
boolean

Marks if the postpayment is enabled or not

MaxDebt
number <double>

The maximum negative balance allowed before blocking project if the postpayment is enabled

Responses

Request samples

Content type
application/json
{
  • "IsPostPaid": true,
  • "MaxDebt": 12.34
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get companies by ID

Returns a list of all project companies. Only one company can be active
Available for the User role

path Parameters
id
required
integer <int32>

Project ID that can be used to retrieve a list of companies

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create company

Create a new company. If a project has an active company, it will be deactivated / switched to InActive
Available for the User role

path Parameters
id
required
integer <int32>

ID of the project for which a new company is to be created

Request Body schema: application/json
CountryTwoLetterCode
required
string
Enum: "RU" "KZ" "BY"

Two-letter country ID where the company is registered

INN
string

Taxpayer ID (ИНН). Mandatory for RU companies

UNP
string

Taxpayer ID (УНП). Mandatory for BY companies

BIN
string

Taxpayer ID (БИН). Mandatory for KZ companies

CompanyName
string

Company name

Kbe
string

Benificiar Code. For KZ companies

LegalAddress
required
string

Legal address

ActualAddress
required
string

Actual address

KPP
string

Tax registration reason code (КПП). For RU companies

AutoInvoiceAmount
required
number <double>

Sum of automatically generated invoices

TypeAutoInvoiceGeneration
required
string
Enum: "NotGenerate" "StartOfMonth" "DaysBeforeZeroBalance7" "DaysBeforeZeroBalance14"

Intervals of automatic invoices generation

Ogrn
string

Primary State Registration Number (ОГРН), only for RU companies

Okpo
string

Russian National Nomenclature of Business and Organization (ОКПО), only for RU companies

CheckingAccount
string

Current invoice number

CorrespondentAccount
string

Correspondent account

Bank
string

Bank

Bik
string

Bank identification code

SignatoryName
string

Name of the signatory

SignatoryJob
string

Job title of the signatory

AgreementNumber
required
string

Agreement number

AgreementDate
required
string <date-time>

Agreement date

CanUserEditCompanyData
required
boolean

If the user can edit the data

FinanceEmail
required
string

Email for receiving invoices and acts

PartnerCompanyId
required
integer <int32>

Partner's company ID

Responses

Request samples

Content type
application/json
{
  • "CountryTwoLetterCode": "RU",
  • "INN": "7838413489",
  • "CompanyName": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ИТГЛОБАЛКОМ РУС\"",
  • "LegalAddress": "191028, ГОРОД САНКТ-ПЕТЕРБУРГ, ПР-КТ ЛИТЕЙНЫЙ, Д. 26, ЛИТ. А, ОФИС 5-23",
  • "ActualAddress": "191028, ГОРОД САНКТ-ПЕТЕРБУРГ, ПР-КТ ЛИТЕЙНЫЙ, Д. 26, ЛИТ. А, ОФИС 5-23",
  • "KPP": "784101001",
  • "AutoInvoiceAmount": 444,
  • "TypeAutoInvoiceGeneration": "DaysBeforeZeroBalance7",
  • "Ogrn": "1089847323180",
  • "Okpo": "87350562",
  • "Bank": "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО «БАНК «САНКТ-ПЕТЕРБУРГ»",
  • "Bik": "044030790",
  • "SignatoryName": "Иванов Иван Иванович",
  • "SignatoryJob": "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР",
  • "AgreementNumber": "1311/544",
  • "AgreementDate": "2021-08-12T15:19:27.1211245Z",
  • "CanUserEditCompanyData": true,
  • "FinanceEmail": "example@gmail.com",
  • "PartnerCompanyId": 1
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get company by ID

Returns specification of one project company
Available for the User role

path Parameters
id
required
integer <int32>

Project ID for which a company details are needed

company_id
required
integer <int32>

Company ID for which details are needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Edit company by ID

Changes an existing active company without deactivating it
Available for the User role

path Parameters
id
required
integer <int32>

Project ID which company details are to be changed

company_id
required
integer <int32>

Company ID which details are to be changed

Request Body schema: application/json
CompanyName
string

Company name

Kbe
string

Benificiar Code. For KZ companies

LegalAddress
required
string

Legal address

ActualAddress
required
string

Actual address

KPP
string

Tax registration reason code (КПП). For RU companies

AutoInvoiceAmount
required
number <double>

Sum of automatically generated invoices

TypeAutoInvoiceGeneration
required
string
Enum: "NotGenerate" "StartOfMonth" "DaysBeforeZeroBalance7" "DaysBeforeZeroBalance14"

Intervals of automatic invoices generation

Ogrn
string

Primary State Registration Number (ОГРН), only for RU companies

Okpo
string

Russian National Nomenclature of Business and Organization (ОКПО), only for RU companies

CheckingAccount
string

Current invoice number

CorrespondentAccount
string

Correspondent account

Bank
string

Bank

Bik
string

Bank identification code

SignatoryName
string

Name of the signatory

SignatoryJob
string

Job title of the signatory

CanUserEditCompanyData
required
boolean

If the user can edit the data

FinanceEmail
required
string

Email for receiving invoices and acts

Responses

Request samples

Content type
application/json
{
  • "CompanyName": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ИТГЛОБАЛКОМ РУС\"",
  • "LegalAddress": "191028, ГОРОД САНКТ-ПЕТЕРБУРГ, ПР-КТ ЛИТЕЙНЫЙ, Д. 26, ЛИТ. А, ОФИС 5-23",
  • "ActualAddress": "191028, ГОРОД САНКТ-ПЕТЕРБУРГ, ПР-КТ ЛИТЕЙНЫЙ, Д. 26, ЛИТ. А, ОФИС 5-23",
  • "KPP": "784101001",
  • "AutoInvoiceAmount": 444,
  • "TypeAutoInvoiceGeneration": "DaysBeforeZeroBalance7",
  • "Ogrn": "1089847323180",
  • "Okpo": "87350562",
  • "CheckingAccount": "3219",
  • "CorrespondentAccount": "301018",
  • "Bank": "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО «БАНК «САНКТ-ПЕТЕРБУРГ»",
  • "Bik": "044030790",
  • "SignatoryName": "Иванов Иван Иванович",
  • "SignatoryJob": "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР",
  • "CanUserEditCompanyData": true,
  • "FinanceEmail": "example@gmail.com"
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Deactivate the company

Changes the company state to InActive
Available for the User role

path Parameters
id
required
integer <int32>

Project ID which company state is to be changed to InActive

company_id
required
integer <int32>

Company ID which state is to be changed to InActive

Responses

List of invoices

Returns a list of company project invoices
Available for the User and Finance roles

path Parameters
id
required
integer <int32>

Project ID for which a list of invoices is needed

company_id
required
integer <int32>

Company ID for which a list of invoices is needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create invoice

Create an invoice in the New state
Available for the User and Finance roles

path Parameters
id
required
integer <int32>

Project ID for which a new invoice is to be created

company_id
required
integer <int32>

Company ID for which a new invoice is to be created

Request Body schema: application/json
Amount
required
number <double>

Total sum to be charged (including VAT). VAT rate is defined by the system settings

Responses

Request samples

Content type
application/json
{
  • "Amount": 1234
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get invoice by ID

Returns one invoice of company project
Available for the User and Finance roles

path Parameters
id
required
integer <int32>

Project ID for which an invoice is needed

company_id
required
integer <int32>

Company ID for which an invoice is needed

invoice_number
required
string

Invoice number for which details are needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

1С

Information about 1C service

List of configurations

Returns a list of 1C configurations available for ordering
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Tariffs

Returns a rates scale for 1C services
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create

Creating a 1C configuration order
Available for the User role

path Parameters
id
required
integer <int32>

Project ID for which a 1C order is to be created

Request Body schema: application/json
IsRdpAccess
required
boolean

If the current RDP configurations have access, or it's available via Web

required
Array of objects

Array of type Configuration1C objects

required
Array of objects

Array of type User1C objects

Responses

Request samples

Content type
application/json
{
  • "IsRdpAccess": false,
  • "Configurations":
    [
    ],
  • "Users":
    [
    ]
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

IaaS

Information about IaaS service

List

Returns a list of locations for VMware servers order
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get location by ID

Returns details by specific location for creating a VMware server
Available for the User role

path Parameters
location_id
required
string

Location ID (technical name) for which details are needed

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create VMware server

Creating a Vmware server for active and inactive user
Available for the User role

path Parameters
id
required
integer <int32>

Project ID for which a VMware server is to be created

location_name
required
string

Technical name of the location where a new VMware server is to be created

Request Body schema: application/json
Name
required
string

Name of the ordered server. Max number of symbols: 50

CPU
required
integer <int32>

Cores number

RAM
required
integer <int32>

RAM amount, MB

HDD
required
integer <int32>

Volume in GB

HDDType
required
string
Enum: "SSD" "SAS"

Vloume type

NetworkId
integer <int32>

Public client network ID

NetworkBandwidth
integer <int32>

Public network bandwidth (10 Mbit/s by default)

ImageID
required
integer <int32>

Server template ID

ISPSoftID
integer <int32>

ISP software ID

IsBackupActive
required
boolean

If the server backup is enabled

BackupPeriod
required
integer <int32>
Enum: 7 14 21 28

Depth of backup

SshKeys
Array of integers <int32>

SSH keys ID. If none is defined, server will use login and password authentication

IsNeedSysprep
boolean

If Sysprep is available

Responses

Request samples

Content type
application/json
{
  • "Name": "Example-Server",
  • "CPU": 3,
  • "RAM": 1024,
  • "HDD": 10,
  • "HDDType": "SSD",
  • "NetworkBandwidth": 30,
  • "ImageID": 48,
  • "IsBackupActive": true,
  • "BackupPeriod": 7
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Payments

Information about payments

List

Returns a list of bank payments
Available for the Finance role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create bank payment

Processing a new incoming bank payment
Available for the Finance role

Request Body schema: application/json
Number
required
string

Distinct payment number

TIN
required
string

Company ID that made a payment. This field contains its INN, BIN, or UNP

Amount
required
number <double>

Sum of received payment (including VAT)

InvoiceNumber
integer <int32>

Number of a generated invoice. Additional identifier of the company which made a payment

CompanyId
integer <int32>

Company ID. Additional identifier of the company which made a payment

ProjectId
integer <int32>

Project ID. Additional identifier of the project which made a payment

Responses

Request samples

Content type
application/json
{
  • "Number": "678",
  • "TIN": "1234567891",
  • "Amount": 556,
  • "InvoiceNumber": "1517",
  • "CompanyId": 522,
  • "ProjectId": 1317
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create online payment

Processing a new incoming online payment
Available for the Finance role

Request Body schema: application/json
PaymentId
required
string

Distinct payment number

Amount
required
number <double>

Sum of received payment (including VAT)

ProjectId
required
integer <int32>

Project ID to which payment is to be made

Responses

Request samples

Content type
application/json
{
  • "PaymentId": "BF1R3",
  • "Amount": 20.21,
  • "ProjectId": 1427
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Operations

Information about money transactions

List of all operations

Returns balance operations groupped by project and period
Examples:
/v1/operations/projects?dateFromUtc=2019-07-01&dateToUtc=2019-07-10
/v1/operations/projects?dateFromUtc=20190701T000000Z&dateToUtc=20190710T000000Z
Available for the Finance role

query Parameters
dateFromUtc
required
string <date-time>

Date since which to search operations (including the date). Parameter name is case-sensitive

dateToUtc
required
string <date-time>

Date until which to search operations (including the date). Parameter name is case-sensitive

Responses

Response samples

Content type
application/json
{
  • "Result":
    [
    ]
}

List of project operations

Returns balance operations groupped by project and period
Examples:
/v1/operations/projects?dateFromUtc=2019-07-01&dateToUtc=2019-07-10
/v1/operations/projects?dateFromUtc=20190701T000000Z&dateToUtc=20190710T000000Z
Available for the Finance role

path Parameters
id
required
integer <int32>

Project ID for which need to get operations

query Parameters
dateFromUtc
required
string <date-time>

Date since which to search operations (including the date). Parameter name is case-sensitive

dateToUtc
required
string <date-time>

Date until which to search operations (including the date). Parameter name is case-sensitive

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Create operation

Create a new operation
Available for the Finance role

path Parameters
id
required
integer <int32>

ID of the project for which a new operation is to be created

Request Body schema: application/json
TypeOperation
required
string
Enum: "DengiOnlinePlus" "BonusPlus" "BonusMinus"

Operations type: DengiOnline Plus – crediting of funds to a project, BonusPlus – crediting of bonuses, BonusMinus – charging off bonuses

Amount
required
number <double>

Operation sum. Positive. Validates two characters after the dot

Responses

Request samples

Content type
application/json
{
  • "TypeOperation": "DengiOnlinePlus",
  • "Amount": 1234
}

Response samples

Content type
application/json
{ }

vStack

Information about vStack service

Get prices and configurations

Returns all available vStack server configurations with prices
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "OsFamilies":
    [
    ],
  • "Locations":
    [
    ],
  • "Templates":
    [
    ],
  • "Configurations":
    [
    ],
  • "BasicConfigurations":
    [
    ],
  • "MandatoryLicenses":
    [
    ],
  • "PriceVolumePerGb": 0.36,
  • "PriceSnapshotPerGb": 10,
  • "PriceBandwidthPerMbps": 0.3,
  • "PriceIpAddress": 2.4
}

Create vStack server

Create a vStack server
Available for the User role

path Parameters
id
required
integer <int32>

Project ID for which a new vStack server is to be created

location_id
required
integer <int32>

Location ID where a new vStack server is to be created

Request Body schema: application/json
Name
required
string

Name of the ordered server

Cpu
required
integer <int32>

Cores number

RamMb
required
integer <int32>

RAM amount, MB

TemplateId
required
string

Template ID

required
Array of objects

List of volumes

BandwidthMbps
required
integer <int32>

Interface bandwidth in Mbps, the bandwidth value must be a multiple of 10 Mbps

Responses

Request samples

Content type
application/json
{
  • "Name": "Example",
  • "Cpu": 4,
  • "RamMb": 8192,
  • "TemplateId": "1",
  • "Volumes":
    [
    ],
  • "BandwidthMbps": 50
}

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Managed

Information about Managed service

Tarifs

Returns a rates scale for Managed service
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Object storage

Information about Object storage service

Tariffs

Returns a rates scale for Object storage service
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

SSL-products

Information about SSL service

List

Returns a complete list of SSL products available for sale
Available for the User role

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Get by ID

Returns details of SSL product available for sale by its ID
Available for the User role

path Parameters
product_id
required
integer <int32>

SSL product ID

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}

Reviews

Get reviews

Get reviews

Returns specified number of reviews in random order
Available for the User role

path Parameters
count
required
integer <int32>

Number of reviews to be returned

Responses

Response samples

Content type
application/json
{
  • "Result":
    {
    }
}