...
Open API (Swagger) Integration for Confluence | ||
---|---|---|
| ||
openapi: 3.0.1 info: title: Abills user API version: 0.0.1115 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: Работа с платежными системами - name: config description: Все доступные конфигурации - name: contacts description: Работа с контактами paths: /users/login: post: tags: - user summary: Авторизация пользователя operationId: loginUser requestBody: content: '*/*': schema: $ref: '#/components/schemas/UserLoginBody' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserLogin' /user/{UID}: get: tags: - user summary: Информация о пользователе operationId: userInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/User' security: - USER_SID: [ ] /user/{UID}/pi: get: tags: - user summary: Персональная информация пользователя operationId: userPersonalInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserPi' security: - USER_SID: [ ] /user/{UID}/credit: get: tags: - user summary: Информация об установке кредита operationId: userCreditInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserCreditInfo' security: - USER_SID: [ ] post: tags: - user summary: Установка кредита пользователю operationId: userSetCredit parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserCredit' security: - USER_SID: [ ] /user/{UID}/internet: get: tags: - internet summary: Информация об интернет услугах пользователя operationId: userInternetInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserInternet' security: - USER_SID: [ ] /user/{UID}/internet/{ID}: put: tags: - internet summary: Смена ТП operationId: userChangeInternetTP parameters: - name: UID in: path description: UID пользователя required: true schema: type: 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: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/InternetSpeed' security: - USER_SID: [ ] /user/{UID}/internet/{ID}/holdup: post: tags: - internet summary: Приостановление услуги Интернет operationId: userInternetHoldup parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID услуги Интернет required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/body_1' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/HoldupReply' security: - USER_SID: [ ] x-codegen-request-body-name: body delete: tags: - internet summary: Удаление рассписания на приостановление услуги Интернет operationId: userDeleteInternetHoldup 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/HoldupReply' security: - USER_SID: [ ] /user/{UID}/internet/tariffs: get: tags: - internet summary: Доступные для изменения ТП, на которые хватает денег operationId: userInternetAvailableToChangeTariffs 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/all: get: tags: - internet summary: Все доступные для изменения ТП operationId: userInternetAvailableToChangeTariffsAll 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/{ID}/warnings: get: tags: - internet summary: Информация о списаниях operationId: userInternetWarnings 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/InternetWarnings' security: - USER_SID: [ ] /user/{UID}/abon: get: tags: - abon summary: Информация об периодических списаниях пользователя operationId: userAbonInfo parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserAbon' security: - USER_SID: [ ] /user/{UID}/msgs: get: tags: - msgs summary: Список заявок пользователя operationId: userMsgsList parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsArray' security: - USER_SID: [ ] post: tags: - msgs summary: Создание заявки operationId: userAddMessage parameters: - name: UID in: path description: UID пользователя required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/MsgsAdd' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsAdded' security: - USER_SID: [ ] x-codegen-request-body-name: body /user/{UID}/msgs/{ID}: get: tags: - msgs summary: Информация о заявке пользователя operationId: userMsgs 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/MsgsInfo' security: - USER_SID: [ ] /user/{UID}/msgs/{ID}/reply: get: tags: - msgs summary: Список заявок пользователя operationId: userMsgReplyList 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/MsgsReplyArray' security: - USER_SID: [ ] post: tags: - msgs summary: Создание заявки operationId: userAddReply parameters: - name: UID in: path description: UID пользователя required: true schema: type: string - name: ID in: path description: ID заявки required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/MsgsReplyAdd' required: true responses: 200: description: Успешное выполнение content: { } security: - USER_SID: [ ] x-codegen-request-body-name: body /user/{UID}/msgs/chapters: get: tags: - msgs summary: Список разделов заявок пользователя operationId: userMsgsChapters parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/MsgsArrayChapters' security: - USER_SID: [ ] /user/{UID}/paysys/systems: get: tags: - paysys summary: Список платежных систем доступных пользователю operationId: userPaysysList parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PaysysArray' security: - USER_SID: [ ] /user/{UID}/config: get: tags: - config summary: Список доступных конфигураций пользователя operationId: userConfig parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/UserConfig' security: - USER_SID: [ ] /user/{UID}/paysys/paycurrency: postget: tags: - paysysconfig summary: Формирование ссылкиВалюта на быструю оплатубиллинге operationId: userPaysysPaybillingCurrency parametersresponses: - name200: UID indescription: Успешное pathвыполнение descriptioncontent: UID пользователя required: true application/json: schema: type$ref: string'#/components/schemas/BillingCurrency' /version: requestBodyget: contenttags: '*/*':- config summary: Получить версии биллинга и schema:API $ref: '#/components/schemas/PaysysPayBody' required: trueoperationId: getVersion responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PaysysPay' security: - USER_SID: [ ]Version' /user/{UID}/paysys/transaction/statuspay: post: tags: - paysys summary: Формирование ссылки Проверкана статусабыструю платежаоплату operationId: userPaysysTransactionStatususerPaysysPay parameters: - name: UID in: path description: UID пользователя required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/PaysysTransactionStatusBodyPaysysPayBody' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PaysysTransactionStatusPaysysPay' security: - USER_SID: [ ] components: schemas/user/{UID}/paysys/transaction/status: Userpost: typetags: object properties: - paysys loginsummary: Проверка статуса платежа typeoperationId: stringuserPaysysTransactionStatus parameters: example - name: "3433"UID depositin: path typedescription: UID integerпользователя examplerequired: 1600true creditschema: type: integerstring example: 100requestBody: creditDatecontent: type: string '*/*': exampleschema: 2021-08-13 billId: $ref: '#/components/schemas/PaysysTransactionStatusBody' type: integer required: true exampleresponses: 12 gid200: typedescription: integerУспешное выполнение examplecontent: 57 disable: application/json: type: integer example: 0schema: deleted: $ref: type: integer'#/components/schemas/PaysysTransactionStatus' security: - USER_SID: [ ] /user/{UID}/contacts/push/subscribe: post: example: 0 tags: - contacts UserPi:summary: Подписка на Push уведомления typeoperationId: objectuserPushSubscribeCreate propertiesparameters: - fioname: UID typein: stringpath exampledescription: UID Ивановпользователя Иван Иванович addressFullrequired: true typeschema: string example: ул.Адамца, 121, 3 age: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/PushSubscribeCreateBody' required: true responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PushSubscribe' security: - USER_SID: [ ] delete: tags: - contacts summary: Отписка от Push уведомлений operationId: userPushSubscribeDelete parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PushSubscribe' security: - USER_SID: [ ] get: tags: - contacts summary: Получить FCM токен operationId: userPushSubscribeGet parameters: - name: UID in: path description: UID пользователя required: true schema: type: string responses: 200: description: Успешное выполнение content: application/json: schema: $ref: '#/components/schemas/PushSubscribeInfo' security: - USER_SID: [ ] components: schemas: User: type: object properties: login: type: string example: "3433" deposit: type: integer example: 1600 credit: type: integer example: 100 creditDate: type: string example: 2021-08-13 billId: type: integer example: 12 gid: type: integer example: 57 disable: type: integer example: 0 deleted: type: integer example: 0 UserPi: type: object properties: fio: type: string example: Иванов Иван Иванович addressFull: type: string example: ул.Адамца, 121, 3 age: type: integer example: 33 locationId: type: integer example: 1444 contractId: type: string example: "575493" email: type: array items: type: string example: test@gmail.com phone: type: array items: type: string example: "380976574568" UserInternet: type: array items: $ref: '#/components/schemas/UserInternet_inner' InternetSpeed: type: array items: $ref: '#/components/schemas/InternetSpeed_inner' UserAbon: type: array items: $ref: '#/components/schemas/UserAbon_inner' UserCredit: type: integerobject example: 33properties: locationIdcreditSum: type: integer example: 1444500 contractIdcreditChangePrice: type: stringinteger example: "575493"100 emailuid: type: arrayinteger itemsexample: 11135 type: stringcreditDays: exampletype: test@gmail.com string phone: typeexample: array"3" itemscreditMonthChanges: type: string example: "3809765745681" UserInternetUserCreditInfo: type: arrayobject itemsproperties: $ref: '#/components/schemas/UserInternet_inner'creditChgPrice: InternetSpeed: type: arraystring items: example: "500" $ref: '#/components/schemas/InternetSpeed_inner' UserAboncreditMonthChanges: type: arraystring itemsexample: "1" $ref: '#/components/schemas/UserAbon_inner'creditSum: UserCredit: type: objectstring propertiesexample: "800" creditSumcreditDays: type: integerstring example: 500"3" UserAvailableTariffs: creditChangePricetype: array items: type$ref: integer'#/components/schemas/UserAvailableTariffs_inner' HoldupReply: exampletype: 100 object properties: uidsuccess: type: integer example: 111351 creditDaysmsg: type: string InternetWarnings: exampletype: "3" object properties: creditMonthChangesmessageType: type: string example: "1" success UserCreditInfowarning: type: objectstring properties:example: следующее списание через 7 дней creditChgPricedaysToFee: type: string example: "5002" creditMonthChangessum: type: stringinteger example: "1"150 creditSumabonDate: type: string example: "800" 2021-10-01 InternetChangeTPSuccess: creditDaystype: object properties: typesuccess: string exampletype: "3"integer UserAvailableTariffs: typeexample: array1 itemsuid: $ref type: '#/components/schemas/UserAvailableTariffs_inner'integer HoldupReplyInternetChangeTPError: type: object properties: successerror: type: integer example: 1145 msgmessage: type: string InternetWarnings messageType: type: objectstring propertiesmessageTitle: messageTypetype: string MsgsAdd: type: stringobject example: successproperties: warningchapter: type: stringinteger example: следующее списание через 7 дней3 daysToFeemessage: type: string example: Some "2"message sumsubject: type: integerstring example: Message 150subject abonDatepriority: type: stringinteger example: 2021-10-012 InternetChangeTPSuccessMsgsAdded: type: object properties: successinsertId: type: integer example: 143 uidmsgId: type: integer InternetChangeTPError: typeexample: object43 propertiesaffected: errortype: integer typeexample: integer1 MsgsInfo: example: 145type: object properties: messagesubject: type: string messageType: example: Message type: stringuser api subject messageTitlemessage: type: string MsgsAdd: typeexample: object Test message from user properties:api chapterchapterName: type: integerstring example: Второй 3раздел messagechapter: type: stringinteger example: Some message3 subjectpriority: type: stringinteger example: Message subject2 prioritystate: type: integer example: 20 MsgsAddeddate: type: objectstring properties: example: insertId:2021-09-02 13:20:37 MsgsArray: type: integerarray example: 43items: msgId:$ref: '#/components/schemas/MsgsInfo' MsgsArrayChapters: type: integerarray items: example: 43 $ref: '#/components/schemas/MsgsChapter' affectedMsgsReply: type: object type: integer properties: exampleuid: 1 MsgsInfo: type: objectinteger propertiesexample: 0 subjectaid: type: stringinteger example: Message user api subject2 messageid: type: stringinteger example: Test message from user api54 chapterNametext: type: string example: some Второйreply разделtext chapterdatetime: type: integerstring example: 3 2021-09-02 12:50:47 priorityMsgsReplyAdd: type: integerobject example: 2properties: statereply_text: type: integerstring example: Some reply 0text datereply_subject: type: string example: 2021-09-02 13:20:37 example: Subject MsgsArrayMsgsReplyArray: type: array items: $ref: '#/components/schemas/MsgsInfoMsgsReply' MsgsArrayChaptersbody: type: arrayobject itemsproperties: $ref: '#/components/schemas/MsgsChapter'tp_id: MsgsReply: type: objectinteger propertiesexample: 4 uiddate: type: integerstring example: 02021-09-17 aidperiod: type: integer body_1: exampletype: 2object properties: idfrom_date: type: integerstring example: 542021-08-14 textto_date: type: string example: some reply text2021-08-17 UserInternet_inner: type: object properties: datetimeid: type: stringinteger example: 2021-09-02 12:50:47 2 tpName: MsgsReplyAdd: type: objectstring properties:example: Премиум до 100м reply_texttpId: type: stringinteger example: Some reply text41 reply_subjectinternetStatus: type: stringinteger example: Subject0 MsgsReplyArraycid: type: arraystring items:example: 14:11:11:11:11:c1 $ref: '#/components/schemas/MsgsReply'monthFee: body: type: objectinteger propertiesexample: 250 tp_iddayFee: type: integer example: 40 dateInternetSpeed_inner: type: stringobject example: 2021-09-17properties: periodinSpeed: type: integer body_1: typeexample: object properties:2999 from_dateoutSpeed: type: stringinteger example: 2021-08-143000 to_datetpNum: type: stringinteger example: 2021-08-17155 UserInternetUserAbon_inner: type: object properties: id: type: integer example: 2 tpNamename: type: string example: ПремиумTest доabon 100мTP tpIdprice: type: integer example: 41100 internetStatusperiod: type: integer example: 01 cidnextAbon: type: string example: 14:11:11:11:11:c12021-09-01 monthFeecomments: type: integerstring exampledescription: 250 dayFee: type: integerstring example: Test 0description InternetSpeedUserAvailableTariffs_inner: type: object properties: inSpeedid: type: integer example: 29992 outSpeedname: type: integerstring example: Премиум до 3000100м tpNumtpId: type: integer example: 15541 UserAbon_innermonthFee: type: objectinteger propertiesexample: 250 iddayFee: type: integer example: 20 namecomments: type: string PaysysArray: example: Test abon TPtype: array items: price:$ref: '#/components/schemas/PaymentSystem' PaymentSystem: type: integerobject example: 100properties: periodid: type: integer example: 1 nextAbonname: type: string example: 2021-09-01LiqPay commentsmodule: type: string descriptionexample: Liqpay.pm PaysysPayBody: type: stringobject properties: example: Test descriptionsystemId: UserAvailableTariffs_inner: type: objectinteger propertiesexample: 1 idsum: type: integer example: 2100 nameoperationId: type: string example: Премиум до 100м123456789 tpIdPaysysPay: type: integerobject example: 41properties: monthFeeoperationId: type: integerstring example: 250123456789 dayFeetransactionId: type: integerstring example: 0Liqpay:123456789 commentsurl: type: string PaysysArray example: https://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789 PaysysTransactionStatus: type: arrayobject itemsproperties: $ref: '#/components/schemas/PaymentSystem'id: PaymentSystem: type: objectinteger properties example: 1 iddatetime: type: integerstring example: 1 "2022-01-01 01:01:01" namelogin: type: string example: LiqPaytest modulestatus: type: stringinteger example: Liqpay.pm 1 PaysysPayBodysystemId: type: objectinteger propertiesexample: 1 systemIdsum: type: integer example: 1100 sumuid: type: integer example: 1001 operationIdtransactionId: type: string example: Liqpay:123456789 PaysysPayPaysysTransactionStatusBody: type: object properties: operationIdtransactionId: type: string example: Liqpay:123456789 UserLoginBody: type: object properties: transactionId login: type: string example: Liqpay:123456789testuser urlpassword: type: string example: https://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789 example: testuser PaysysTransactionStatusUserLogin: type: object properties: idlogin: type: integerstring example: 1testuser datetimesid: type: string example: "2022-01-01 01:01:01"sW44EJZLyWDMeXAV loginuid: type: stringinteger example: test1 statusUserConfig: type: integerobject example: 1properties: systemIdcardsUserPayment: type: integer example: 16 sumdocsActsList: type: integer example: 1009 uiddocsInvoicesList: type: integer example: 18 transactionIddocsReceiptList: type: stringinteger example: Liqpay:1234567895 PaysysTransactionStatusBody: typeinternetUserInfo: object properties: type: transactionId:integer typeexample: string3 example: Liqpay:123456789internetUserStats: UserLoginBody: type: objectinteger propertiesexample: 10 loginmsgsUser: type: stringinteger example: testuser1 passwordpaysysPayment: type: stringinteger example: testuser4 UserLoginpaysysSubscribe: type: objectinteger propertiesexample: 7 loginpaysysUserLog: type: stringinteger example: testuser2 MsgsChapter: sid: type: stringobject exampleproperties: sW44EJZLyWDMeXAV uidid: type: integer example: 1 UserConfigname: type: objectstring properties: example: Example cardsUserPayment:chapter BillingCurrency: type: integerobject example: 6properties: docsActsListsystem_currency: type: integer example: 9980 docsInvoicesListVersion: type: integerobject example: 8properties: docsReceiptListversion: type: integerstring example: 50.91.0 internetUserInfoapiVersion: type: integerstring example: 3"0.01" internetUserStatsbilling: type: integerstring example: Abills 10 msgsUserPushSubscribeCreateBody: type: integerobject example: 1properties: paysysPaymenttoken: type: integerstring example: 4"d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM" paysysSubscribePushSubscribe: type: integerobject example: 7properties: paysysUserLogresult: type: integerstring example: 2OK MsgsChapterPushSubscribeInfo: type: object properties: idvalue: type: integerstring example: 1"d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM" nameuid: type: stringinteger example: Example chapter1 securitySchemes: USER_SID: type: apiKey name: USERSID in: header |
...