...
Open API (Swagger) Integration for Confluence |
---|
openapi: 3.0.1 info: title: Abills user API version: 0.0.10 servers: - url: https://demo.abills.net.ua:9443/api.cgi tags: - name: user description: Работа с пользователем - name: internet description: Работа с услугой Интернет - name: msgs description: Работа с заявками пользователя - name: abon description: Работа с периодическими списаниями - name: paysys description: Работа с платежными системами paths: /userusers/{UID}login: getpost: tags: - user summary: ИнформацияАвторизация о пользователепользователя operationId: userInfologinUser parametersrequestBody: - namecontent: UID in: path'*/*': description: UID пользователяschema: required: true schema:$ref: '#/components/schemas/UserLoginBody' typerequired: stringtrue responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/User' security: - USER_SID: []UserLogin' /user/{UID}/pi: get: tags: - user summary: ПерсональнаяИнформация информацияо пользователяпользователе operationId: userPersonalInfouserInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserPiUser' security: - USER_SID: [ ] /user/{UID}/creditpi: get: tags: - user summary: ИнформацияПерсональная обинформация установке кредитапользователя operationId: userCreditInfouserPersonalInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserCreditInfoUserPi' security: - USER_SID: [ ] /user/{UID}/credit: postget: tags: - user summary: УстановкаИнформация об установке кредита пользователю operationId: userSetCredituserCreditInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserCreditUserCreditInfo' security: - USER_SID: [ ] /user/{UID}/internet: getpost: tags: - internetuser summary: ИнформацияУстановка об интернет услугах пользователякредита пользователю operationId: userInternetInfouserSetCredit parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserInternetUserCredit' security: - USER_SID: [ ] /user/{UID}/internet/{ID}: putget: tags: - internet summary: Смена ТПИнформация об интернет услугах пользователя operationId: userChangeInternetTPuserInternetInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: IDresponses: in200: path description: IDУспешное услуги Интернетвыполнение requiredcontent: true schemaapplication/json: type: string schema: requestBody: content:$ref: '#/components/schemas/UserInternet' security: '*/*': - USER_SID: [ ] /user/{UID}/internet/{ID}: put: schematags: - internet $refsummary: '#/components/schemas/body'Смена ТП requiredoperationId: trueuserChangeInternetTP responsesparameters: - 200name: UID descriptionin: Успешное выполнениеpath contentdescription: UID пользователя application/jsonrequired: true schema: type: $ref: '#/components/schemas/InternetChangeTPSuccess'string - name: ID in: path description: ID услуги Интернет required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/body' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/InternetChangeTPSuccess' 400: description: Ошибка content: application/json: schema: $ref: '#/components/schemas/InternetChangeTPError' security: - USER_SID: [ ] x-codegen-request-body-name: body /user/{UID}/internet/{ID}/speed: get: tags: - internet summary: Скорость ТП operationId: userTpSpeed parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID услуги Интернет required: true schema: type: string responses: 400200: description: Успешное Ошибкавыполнение content: application/json: schema: $ref: '#/components/schemas/InternetChangeTPErrorInternetSpeed' security: - USER_SID: [] x-codegen-request-body-name: body ] /user/{UID}/internet/{ID}/speedholdup: getpost: tags: - internet summary: Приостановление Скоростьуслуги ТПИнтернет operationId: userTpSpeeduserInternetHoldup parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID услуги Интернет required: true schema: typeschema: string responses: type: 200:string description: Успешное выполнениеrequestBody: content: application/json'*/*': schema: $ref: '#/components/schemas/InternetSpeedbody_1' security: required: true - USER_SID: []responses: /user/{UID}/internet/{ID}/holdup: post: tags200: - internet description: Успешное выполнение summary: Приостановление услуги Интернет operationIdcontent: userInternetHoldup parameters: - name: UID application/json: in: path schema: description: UID пользователя required$ref: true'#/components/schemas/HoldupReply' security: schema: - USER_SID: [ ] typex-codegen-request-body-name: stringbody delete: - nametags: ID - in: pathinternet summary: Удаление рассписания на description: IDприостановление услуги Интернет operationId: userDeleteInternetHoldup requiredparameters: true - name: schema:UID typein: stringpath requestBody: description: UID content:пользователя '*/*': required: true schema: $reftype: '#/components/schemas/body_1' string - requiredname: trueID responses: 200:in: path description: УспешноеID услуги выполнениеИнтернет contentrequired: true application/jsonschema: type: string schema: responses: 200: $ref: '#/components/schemas/HoldupReply' securitydescription: Успешное выполнение - USER_SIDcontent: [] x-codegen-request-body-name: body deleteapplication/json: tags: - internet schema: summary: Удаление рассписания на приостановление услуги Интернет operationId$ref: userDeleteInternetHoldup'#/components/schemas/HoldupReply' parameterssecurity: - name: UIDUSER_SID: [ ] /user/{UID}/internet/tariffs: get: intags: path - internet description: UID пользователя summary: Доступные для изменения ТП, на которые required:хватает trueденег schema:operationId: userInternetAvailableToChangeTariffs type: stringparameters: - name: IDUID in: path description: IDUID услуги Интернетпользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/HoldupReplyUserAvailableTariffs' security: - USER_SID: [ ] /user/{UID}/internet/tariffs/all: get: tags: - internet summary: Доступные для изменения ТП, на которые хватает денегВсе доступные для изменения ТП operationId: userInternetAvailableToChangeTariffsuserInternetAvailableToChangeTariffsAll parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserAvailableTariffs' security: - USER_SID: [ ] /user/{UID}/internet/tariffs{ID}/allwarnings: get: tags: - internet summary: Все доступные для изменения ТП Информация о списаниях operationId: userInternetWarnings parameters: - name: UID in: path description: UID пользователя required: true schema: operationId: userInternetAvailableToChangeTariffsAll type: parameters:string - name: UIDID in: path description: UIDID пользователяуслуги required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserAvailableTariffsInternetWarnings' security: - USER_SID: [ ] /user/{UID}/internet/{ID}/warningsabon: get: tags: - internet summary: Информация о списаниях operationId: userInternetWarnings parameters: - name: UID in: path description: UID пользователяtags: - abon required: true summary: Информация об периодических списаниях schema:пользователя operationId: userAbonInfo type parameters: string - name: IDUID in: path description: IDUID услугипользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/InternetWarningsUserAbon' security: - USER_SID: [ ] /user/{UID}/abonmsgs: get: tags: - abonmsgs summary: Информация об периодических списанияхСписок заявок пользователя operationId: userAbonInfouserMsgsList parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserAbonMsgsArray' security: - USER_SID: [ ] post: /user/{UID}/msgs: tags: - msgs summary: Создание заявки operationId: userAddMessage getparameters: - tagsname: UID - msgs in: path summarydescription: СписокUID заявок пользователя operationId required: userMsgsListtrue parameters schema: - nametype: UIDstring requestBody: in content: path description'*/*': UID пользователя requiredschema: true schema: $ref: '#/components/schemas/MsgsAdd' typerequired: stringtrue responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsArrayMsgsAdded' security:: - USER_SID: [ ] x-codegen-request-body-name: body - USER_SID: [] /user/{UID}/msgs/{ID}: postget: tags: - msgs summary: Информация о Созданиезаявке заявкипользователя operationId: userAddMessageuserMsgs parameters: - name: UID in: path description: UID пользователя required: true schema: type: string requestBody: - name: ID contentin: path '*/*'description: ID заявки schemarequired: true schema: $ref: '#/components/schemas/MsgsAdd' requiredtype: truestring responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsAddedMsgsInfo' security: - USER_SID: [ ] x-codegen-request-body-name: body /user/{UID}/msgs/{ID}}/reply: get: tags: - msgs summary: ИнформацияСписок о заявкезаявок пользователя operationId: userMsgsuserMsgReplyList parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID заявки required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsInfoMsgsReplyArray' security: - USER_SID: [ ] /user/{UID}/msgs/{ID}/reply: getpost: tags: - msgs summary: СписокСоздание заявок пользователязаявки operationId: userMsgReplyListuserAddReply parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID заявки required: true schema: type: string responsesrequestBody: 200: description: Успешное выполнение content: application/json'*/*': schema: $ref: '#/components/schemas/MsgsReplyArrayMsgsReplyAdd' security: required: true - USER_SID: []responses: post: tags200: - msgs description: Успешное выполнение summary: Создание заявки operationIdcontent: userAddReply{ } parameterssecurity: - nameUSER_SID: [ UID] x-codegen-request-body-name: body in: path/user/{UID}/paysys/systems: get: descriptiontags: UID пользователя - paysys required: true summary: Список платежных систем доступных schema:пользователю operationId: userPaysysList typeparameters: string - name: IDUID in: path description: IDUID заявкипользователя required: true schema: type: string requestBody: content: '*/*'responses: 200: schema: description: Успешное выполнение $ref: '#/components/schemas/MsgsReplyAdd' content: required: true responsesapplication/json: 200: schema: description: Успешное выполнение content$ref: {}'#/components/schemas/PaysysArray' security: - USER_SID: [ ] x-codegen-request-body-name: body /user/{UID}/paysys/systemspay: getpost: tags: - paysys summary: СписокФормирование платежныхссылки системна доступныхбыструю пользователюоплату operationId: userPaysysListuserPaysysPay parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responsesschema: 200: type: string descriptionrequestBody: Успешное выполнение content: application/json'*/*': schema: $ref: '#/components/schemas/PaysysArrayPaysysPayBody' security required: true responses: - USER_SID: [ ] /user/{UID}/paysys/pay200: post: tagsdescription: Успешное выполнение - paysyscontent: summary: Формирование ссылки на быструю оплатуapplication/json: operationId: userPaysysPay parametersschema: - name: UID $ref: '#/components/schemas/PaysysPay' security: in: path - USER_SID: [ ] description: UID пользователя/user/{UID}/paysys/transaction/status: post: requiredtags: true - schema:paysys summary: Проверка type: stringстатуса платежа requestBodyoperationId: userPaysysTransactionStatus contentparameters: - '*/*':name: UID in: schema:path description: UID пользователя $ref: '#/components/schemas/PaysysPayBody' required: true responses schema: 200: type: string descriptionrequestBody: Успешное выполнение content: application/json'*/*': schema: $ref: '#/components/schemas/PaysysPayPaysysTransactionStatusBody' security: required: true - USER_SIDresponses: [ ] /user/{UID}/paysys/transaction/status: post200: tags: description: Успешное выполнение - paysys summary: Проверка статуса платежаcontent: operationId: userPaysysTransactionStatus parametersapplication/json: - name: UID schema: in: path description$ref: UID пользователя'#/components/schemas/PaysysTransactionStatus' required: true security: - USER_SID: [ schema] components: schemas: User: type: stringobject requestBodyproperties: contentlogin: '*/*':type: string example: schema: "3433" deposit: $ref type: '#/components/schemas/PaysysTransactionStatusBody'integer required example: true1600 responses credit: 200 type: integer descriptionexample: Успешное выполнение100 contentcreditDate: application/json:type: string example: 2021-08-13 schema: billId: $reftype: '#/components/schemas/PaysysTransactionStatus'integer security: example: 12 - USER_SID: [ ] components: schemasgid: User: type: objectinteger properties: example: 57 logindisable: type: stringinteger example: "3433"0 depositdeleted: type: integer example: 0 UserPi: 1600 type: object properties: creditfio: type: integerstring example: Иванов Иван 100Иванович creditDateaddressFull: type: string example: 2021-08-13 ул.Адамца, 121, 3 billIdage: type: integer example: 1233 gidlocationId: type: integer example: 571444 disablecontractId: type: integerstring example: 0"575493" deletedemail: type: integerarray exampleitems: 0 UserPi: type: objectstring properties: fio:example: test@gmail.com typephone: string exampletype: Ивановarray Иван Иванович addressFullitems: type: string example: ул.Адамца, 121, 3"380976574568" ageUserInternet: type: integerarray items: example: 33 $ref: '#/components/schemas/UserInternet_inner' locationIdInternetSpeed: type: array type: integer items: example: 1444$ref: '#/components/schemas/InternetSpeed_inner' contractIdUserAbon: type: stringarray items: example: "575493" $ref: '#/components/schemas/UserAbon_inner' emailUserCredit: type: object type: array properties: itemscreditSum: type: stringinteger example: test@gmail.com500 phonecreditChangePrice: type: arrayinteger itemsexample: 100 type: stringuid: exampletype: "380976574568"integer UserInternet: typeexample: array11135 items: $ref: '#/components/schemas/UserInternet_inner'creditDays: InternetSpeed: type: arraystring items: example: "3" $ref: '#/components/schemas/InternetSpeed_inner'creditMonthChanges: UserAbon: type: arraystring items: $ref: '#/components/schemas/UserAbon_inner'example: "1" UserCreditUserCreditInfo: type: object properties: creditSumcreditChgPrice: type: integerstring example: "500" creditChangePricecreditMonthChanges: type: integerstring example: 100"1" uidcreditSum: type: integerstring example: 11135"800" creditDays: type: string example: "3" UserAvailableTariffs: creditMonthChanges: type: array typeitems: string example: "1"$ref: '#/components/schemas/UserAvailableTariffs_inner' UserCreditInfoHoldupReply: type: object properties: creditChgPricesuccess: type: stringinteger example: "500"1 creditMonthChangesmsg: type: string InternetWarnings: example: "1"type: object properties: creditSummessageType: type: string example: "800"success creditDayswarning: type: string example: "3" следующее списание через 7 UserAvailableTariffs:дней typedaysToFee: array items: $ref: '#/components/schemas/UserAvailableTariffs_inner'type: string HoldupReply: typeexample: object"2" propertiessum: successtype: integer typeexample: integer150 abonDate: example: 1 type: msg:string typeexample: string2021-10-01 InternetWarningsInternetChangeTPSuccess: type: object properties: messageTypesuccess: type: stringinteger example: success1 warninguid: type: stringinteger InternetChangeTPError: exampletype: object следующее списание через 7 днейproperties: daysToFeeerror: type: stringinteger example: "2"145 summessage: type: integerstring examplemessageType: 150 abonDate: type: string example: 2021-10-01messageTitle: InternetChangeTPSuccess: type: objectstring properties: successMsgsAdd: type: integerobject example: 1properties: uidchapter: type: integer InternetChangeTPError: type: object properties:example: 3 errormessage: type: integerstring example: 145Some message messagesubject: type: string messageTypeexample: Message subject typepriority: string messageTitletype: integer typeexample: string2 MsgsAddMsgsAdded: type: object properties: chapterinsertId: type: integer example: 343 messagemsgId: type: stringinteger example: Some message43 subjectaffected: type: stringinteger example: Message subject 1 MsgsInfo: type: object properties: prioritysubject: type: integerstring example: 2 Message user api subject message: MsgsAddedtype: string type: object example: Test message from user properties:api insertIdchapterName: type: integerstring example: Второй 43раздел msgIdchapter: type: integer example: 433 affectedpriority: type: integer example: 12 MsgsInfo state: type: objectinteger properties: example: 0 subjectdate: type: string example: Message user api subject 2021-09-02 13:20:37 MsgsArray: messagetype: array items: type$ref: string'#/components/schemas/MsgsInfo' MsgsReply: exampletype: Testobject message from user apiproperties: chapterNameuid: type: stringinteger example: Второй раздел0 chapteraid: type: integer example: 32 priorityid: type: integer example: 254 statetext: type: integerstring example: some reply 0text datedatetime: type: string example: 2021-09-02 1312:2050:3747 MsgsArrayMsgsReplyAdd: type: arrayobject itemsproperties: $ref: '#/components/schemas/MsgsInfo'reply_text: MsgsReply: type: objectstring properties:example: Some reply text uidreply_subject: type: integerstring example: 0Subject MsgsReplyArray: aid type: array items: type $ref: integer'#/components/schemas/MsgsReply' body: example: 2type: object properties: tp_id: type: integer example: 544 textdate: type: string example: some reply text2021-09-17 datetimeperiod: type: stringinteger body_1: exampletype: 2021-09-02 12:50:47object properties: MsgsReplyAdd from_date: type: objectstring properties: example: 2021-08-14 replyto_textdate: type: string example: Some reply text2021-08-17 reply_subjectUserInternet_inner: type: object type: string properties: exampleid: Subject MsgsReplyArray: type: arrayinteger items: example: 2 $ref: '#/components/schemas/MsgsReply'tpName: body: type: objectstring properties: example: Премиум до 100м tp_idtpId: type: integer example: 441 dateinternetStatus: type: stringinteger example: 2021-09-170 periodcid: type: integerstring body_1: type: object properties:example: 14:11:11:11:11:c1 from_datemonthFee: type: stringinteger example: 2021-08-14250 to_datedayFee: type: stringinteger example: 2021-08-170 UserInternetInternetSpeed_inner: type: object properties: idinSpeed: type: integer example: 22999 tpNameoutSpeed: type: stringinteger example: Премиум до 100м3000 tpIdtpNum: type: integer example: 41155 internetStatusUserAbon_inner: type: integerobject example: 0properties: cidid: type: stringinteger example: 14:11:11:11:11:c12 monthFeename: type: integerstring example: Test 250abon TP dayFeeprice: type: integer example: 0100 InternetSpeed_inner period: type: objectinteger properties: example: 1 inSpeednextAbon: type: integerstring example: 29992021-09-01 outSpeedcomments: type: integerstring exampledescription: 3000 tpNum: type: integerstring example: Test 155description UserAbonUserAvailableTariffs_inner: type: object properties: id: type: integer example: 2 name: type: string example: TestПремиум abonдо TP100м pricetpId: type: integer example: 10041 periodmonthFee: type: integer example: 1250 nextAbondayFee: type: stringinteger example: 2021-09-010 comments: type: string PaysysArray: description: type: array typeitems: string example: Test description$ref: '#/components/schemas/PaymentSystem' UserAvailableTariffs_innerPaymentSystem: type: object properties: id: type: integer example: 21 name: type: string example: Премиум до 100мLiqPay tpIdmodule: type: integerstring example: 41Liqpay.pm monthFeePaysysPayBody: type: integerobject example: 250properties: dayFeesystemId: type: integer example: 0 1 sum: commentstype: integer typeexample: string100 PaysysArray operationId: type: array type: string items: $refexample: '#/components/schemas/PaymentSystem'123456789 PaymentSystemPaysysPay: type: object properties: idoperationId: type: integerstring example: 1123456789 nametransactionId: type: string example: LiqPayLiqpay:123456789 moduleurl: type: string example: Liqpay.pmhttps://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789 PaysysPayBodyPaysysTransactionStatus: type: object properties: systemIdid: type: integer example: 1 sum: type: integer example: 100 operationIddatetime: type: string example: 123456789 "2022-01-01 01:01:01" PaysysPaylogin: type: objectstring properties: example: test operationIdstatus: type: stringinteger example: 1234567891 transactionIdsystemId: type: stringinteger example: Liqpay:1234567891 urlsum: type: stringinteger example: https://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789 100 PaysysTransactionStatusuid: type: objectinteger propertiesexample: 1 idtransactionId: type: integerstring example: 1Liqpay:123456789 datetimePaysysTransactionStatusBody: type: stringobject example: "2022-01-01 01:01:01"properties: logintransactionId: type: string example: testLiqpay:123456789 statusUserLoginBody: type: integerobject example: 1properties: systemIdlogin: type: integerstring example: 1testuser sumpassword: type: integerstring example: 100testuser uidUserLogin: type: integerobject example: 1properties: transactionIdlogin: type: string example: Liqpay:123456789 testuser PaysysTransactionStatusBodysid: type: objectstring properties: example: sW44EJZLyWDMeXAV transactionIduid: type: stringinteger example: Liqpay:1234567891 securitySchemes: USER_SID: type: apiKey name: USERSID in: header |
...