Versions Compared

Old Version 1

changes.mady.by.user Alexandr Stokipny

Saved on

compared with

New Version Current

changes.mady.by.user Svitlana Nimych

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Запрос служит для получения данных о поддерживаемых Сервисом поставщиках услуг мобильной электронной подписи.

URL-адрес запроса

https://localhost:9094ccs-dev-api.cipher.kiev.ua/ccs/api/v1/mssp

Метод

GET

Параметры запроса

...

Настраиваемые заголовки запроса

Отсутствует

Ответ
Код ответаContent-typeДопустимые параметрыПример содержимого
200application/json
ca{
"ca":
Array
[
    
{
        "
name
msspId": "
КНЕДП/АЦСК ПАТ КБ \"ПРИВАТБАНК\""
IdHubTest1",
        
"
id
msspTitle": "
privat"
Тестовий постачальник послуг
}
1",
{
"name
 "operatorPrefixes":
"КНЕДП/АЦСК ІДД ДФС",
[
"id":
 "
iddDfs
063",
 
},
{
"073",
 
"name":
  "
Тестовий ЦСК Сайфер
093"
,

 
"id": "testIitCipher"
]
    
},
    {
        "
name
msspId": "
КНЕДП/АЦСК ТОВ \"Центр сертифікації ключів \"Україна\""
IdHubTest2",
        
"
id
msspTitle": "
tovUkraine"
Тестовий постачальник послуг
}
2",
 
{
     
"
name
operatorPrefixes":
"Тестовий
[
ЦСК
ИИТ",
"id":
 "
testIitCa"
}
063",
 
{
        
"
name": "Тестовий ЦСК Сайфер (проксі)"
073",
 
"id":
 "
testIitCipherProxy
093"
 
}
  ]
    
}
] 
}
500
503
application/jsonmessage
failureCause 
{
    "message" : "
Сервис хранения данных не запущен." 
Краткое описание ошибки.",
    "failureCause" : "Дополнительная иформация, детали, значения параметров, которые относятся к ошибке"
}
Параметры JSON объекта ответа
Параметр
Тип данных
Описание
messageStringОписание результата проведения операции
ca
ArrayArrayМассив поддерживаемых
Сервисом КПЭДУ/(А)ЦСК
ПУМЭП
failureCause String

Дополнительная иформация об ошибке:

  • дополнительное описание
  • значения параметров и переменных
  • текстовое описание исключения
  • "stack trace" исключения в случае отсутствия у него текстового описания
  • другие данные, которые могут идентифицировать ошибку

Наличие всех, одного или нескольких типов дополнительной информации в поле "failureCause" необязательно.

Поля элемента Массив поддерживаемых ПУМЭППоля элемента массива ca

Поле
Тип данных
Описание
name
msspIdString
Название КПЭДУ/(А)ЦСК на украинском языке. Название на локализируется.idStringИдентификатор КПЭДУ/(А)ЦСК, который используется для ссылки на данный КПЭДУ/(А)ЦСК внутри Сервиса
Пример кода на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url: "https://localhost:9094/api/v1/certificateAuthority/supported",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    ca = jsonResponse.ca;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при получении списка поддерживаемых КПЭДУ/(А)ЦСК." : xhr.responseText;
    }
})

 

...

Идентифификатор ПУМЭП
msspTitleStringНазвание ПУМЭП для отображения в интерфейсе пользователя
operatorPrefixesArrayМассив строк, каждая из которых представляет допустимый префикс-код, который зарезервирован оператором мобильной связи, с которым связан ПУМЭП