Openprovider EasydmarcOrder API

swagger: '2.0'
info:
  title: REST AdditionalData EasydmarcOrder API
  version: 1.0.0-beta
host: api.openprovider.eu
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- Bearer: []
tags:
- name: EasydmarcOrder
paths:
  /v1beta/easydmarcs:
    get:
      tags:
      - EasydmarcOrder
      summary: Get easy dmarc
      operationId: GetEasyDmarc
      parameters:
      - type: string
        description: Domain name without extension.
        name: domain.name
        in: query
      - type: string
        description: Domain extension.
        name: domain.extension
        in: query
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderGetEasyDmarcResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
    post:
      tags:
      - EasydmarcOrder
      summary: Create easy dmarc
      operationId: CreateEasyDmarc
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/orderCreateEasyDmarcRequest'
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderCreateEasyDmarcResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
  /v1beta/easydmarcs/list:
    get:
      tags:
      - EasydmarcOrder
      summary: List easy dmarc
      operationId: ListEasyDmarc
      parameters:
      - type: integer
        format: int32
        default: 100
        description: Search query limit.
        name: limit
        in: query
      - type: integer
        format: int32
        default: 0
        description: Search query offset.
        name: offset
        in: query
      - type: string
        description: desc/asc.
        name: order_by.id
        in: query
      - type: array
        items:
          type: string
        collectionFormat: multi
        description: Array of order statuses.
        name: status
        in: query
      - type: string
        description: Domain name without extension.
        name: domain.name
        in: query
      - type: string
        description: Domain extension.
        name: domain.extension
        in: query
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderListEasyDmarcResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
  /v1beta/easydmarcs/{id}:
    delete:
      tags:
      - EasydmarcOrder
      summary: Delete easy dmarc
      operationId: DeleteEasyDmarc
      parameters:
      - type: integer
        format: int32
        description: Easydmarc id (order number)
        name: id
        in: path
        required: true
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderDeleteEasyDmarcResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
  /v1beta/easydmarcs/{id}/retry:
    post:
      tags:
      - EasydmarcOrder
      summary: Retry easy dmarc
      operationId: RetryEasyDmarc
      parameters:
      - type: integer
        format: int32
        description: Easydmarc id (order number)
        name: id
        in: path
        required: true
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/orderRetryEasyDmarcRequest'
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderRetryEasyDmarcResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
  /v1beta/easydmarcs/{id}/sso:
    get:
      tags:
      - EasydmarcOrder
      summary: Get easy dmarc sso
      operationId: GetEasyDmarcSso
      parameters:
      - type: integer
        format: int32
        description: Easy Dmarc id (order id)
        name: id
        in: path
        required: true
      - type: string
        description: SSO url on behalf of the customer or reseller.
        name: type
        in: query
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/orderGetEasyDmarcSsoResponse'
        default:
          description: (empty)
          schema:
            $ref: '#/definitions/errorError'
definitions:
  orderRecentEasyDmarcAction:
    type: object
    title: RecentEasyDmarcAction
    properties:
      message:
        type: string
        title: Additional information of last action if failed
      recent_action:
        type: string
        title: Recently triggered action on EasyDmarc API
    example:
      message: ''
      recent_action: enabled
  orderRetryEasyDmarcRequest:
    type: object
    title: RetryEasyDmarcRequest
    properties:
      id:
        type: integer
        format: int32
        title: Easydmarc id (order number)
    example:
      id: 123456789
  orderListEasyDmarcResponseData:
    type: object
    title: ListEasyDmarcResponseData
    properties:
      results:
        type: array
        title: Results list
        items:
          $ref: '#/definitions/orderListEasyDmarcOrder'
      total:
        type: integer
        format: int32
        title: Results count
    example:
      results:
      - activated_at: '2019-01-01 0:00:01'
        domain:
          extension: london
          name: test4
        expired_at: '2019-01-01 0:00:01'
        id: 123456789
        record_host: ''
        record_type: ''
        record_value: ''
        renew_at: '2019-01-01 0:00:01'
        status: ''
      total: 999
  orderCreateEasyDmarcRequest:
    type: object
    title: CreateEasyDmarcRequest
    properties:
      domain:
        title: Domain name and extension
        $ref: '#/definitions/orderDomain'
      owner_handle:
        type: string
        title: Domain owner handle value
    example:
      domain:
        extension: london
        name: test4
      owner_handle: XX123456-XX
  orderDeleteEasyDmarcResponseData:
    type: object
    title: DeleteEasyDmarcResponseData
    properties:
      status:
        type: string
        title: Easy Dmarc status
    example:
      status: ACT
  orderDeleteEasyDmarcResponse:
    type: object
    title: DeleteEasyDmarcResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderDeleteEasyDmarcResponseData'
      desc:
        type: string
        title: Response description
      maintenance:
        type: boolean
        format: boolean
        title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
      warnings:
        type: array
        title: Contains warning responses if any
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        status: ACT
      desc: ''
  orderGetEasyDmarcSsoResponseData:
    type: object
    title: GetEasyDmarcSsoResponseData
    properties:
      url:
        type: string
        title: Single sign on url along with one time passsword token as query params
    example:
      url: ''
  orderGetEasyDmarcSsoResponse:
    type: object
    title: GetEasyDmarcSsoResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderGetEasyDmarcSsoResponseData'
      desc:
        type: string
        title: Response description
      maintenance:
        type: boolean
        format: boolean
        title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
      warnings:
        type: array
        title: Contains warning responses if any
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        url: ''
      desc: ''
  orderCreateEasyDmarcResponse:
    type: object
    title: CreateEasyDmarcResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderEasyDmarcOrder'
      desc:
        type: string
        title: Response description
      warnings:
        type: array
        title: Array of warning messages
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        activated_at: '2019-01-01 0:00:01'
        domain:
          extension: london
          name: test4
        easydmarc_email_address: ''
        expired_at: '2019-01-01 0:00:01'
        id: 123456789
        recent_easydmarc_action:
          message: ''
          recent_action: enabled
        record_host: ''
        record_type: ''
        record_value: ''
        renew_at: '2019-01-01 0:00:01'
        status: ''
      desc: ''
  orderListEasyDmarcResponse:
    type: object
    title: ListEasyDmarcResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderListEasyDmarcResponseData'
      desc:
        type: string
        title: Response description
      maintenance:
        type: boolean
        format: boolean
        title: Indicates if Openprovider API is on maintenance
      warnings:
        type: array
        title: Array of warning messages
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        results:
        - activated_at: '2019-01-01 0:00:01'
          domain:
            extension: london
            name: test4
          expired_at: '2019-01-01 0:00:01'
          id: 123456789
          record_host: ''
          record_type: ''
          record_value: ''
          renew_at: '2019-01-01 0:00:01'
          status: ''
        total: 999
      desc: ''
  orderDomain:
    type: object
    title: Domain
    properties:
      extension:
        type: string
        title: Domain extension
      name:
        type: string
        title: Domain name without extension
    example:
      extension: london
      name: test4
  orderListEasyDmarcOrder:
    type: object
    title: ListEasyDmarcOrder
    properties:
      activated_at:
        type: string
        title: date when we order has been activated last time
      domain:
        title: Domain name and extension
        $ref: '#/definitions/orderDomain'
      expired_at:
        type: string
        title: date when order has been expired
      id:
        type: integer
        format: int32
        title: Order id number
      record_host:
        type: string
        title: Easy Dmarc CNAME record host
      record_type:
        type: string
        title: Easy Dmarc CNAME record type
      record_value:
        type: string
        title: Easy Dmarc CNAME record value
      renew_at:
        type: string
        title: date when we will request automatic renew
      status:
        type: string
        title: Status of order
    example:
      activated_at: '2019-01-01 0:00:01'
      domain:
        extension: london
        name: test4
      expired_at: '2019-01-01 0:00:01'
      id: 123456789
      record_host: ''
      record_type: ''
      record_value: ''
      renew_at: '2019-01-01 0:00:01'
      status: ''
  orderGetEasyDmarcResponse:
    type: object
    title: GetEasyDmarcResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderEasyDmarcOrder'
      desc:
        type: string
        title: Response description
      maintenance:
        type: boolean
        format: boolean
        title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
      warnings:
        type: array
        title: Contains warning responses if any
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        activated_at: '2019-01-01 0:00:01'
        domain:
          extension: london
          name: test4
        easydmarc_email_address: ''
        expired_at: '2019-01-01 0:00:01'
        id: 123456789
        recent_easydmarc_action:
          message: ''
          recent_action: enabled
        record_host: ''
        record_type: ''
        record_value: ''
        renew_at: '2019-01-01 0:00:01'
        status: ''
      desc: ''
  errorWarning:
    type: object
    title: Warning
    properties:
      code:
        type: integer
        format: int32
        title: Warning code
      data:
        type: string
        title: Additional warning description
      desc:
        type: string
        title: Warning description
    example:
      code: 0
      data: ''
      desc: ''
  orderEasyDmarcOrder:
    type: object
    title: EasyDmarcOrder
    properties:
      activated_at:
        type: string
        title: date when we order has been activated last time
      domain:
        title: Domain name and extension
        $ref: '#/definitions/orderDomain'
      easydmarc_email_address:
        type: string
        title: Email address (fake) used in the easy dmarc account
      expired_at:
        type: string
        title: date when order has been expired
      id:
        type: integer
        format: int32
        title: Easydmarc id (order number)
      recent_easydmarc_action:
        title: Recent client chronicle action and additional information
        $ref: '#/definitions/orderRecentEasyDmarcAction'
      record_host:
        type: string
        title: Easy Dmarc CNAME record host
      record_type:
        type: string
        title: Easy Dmarc CNAME record type
      record_value:
        type: string
        title: Easy Dmarc CNAME record value
      renew_at:
        type: string
        title: date when we will request automatic renew
      status:
        type: string
        title: Status of easy dmarc
    example:
      activated_at: '2019-01-01 0:00:01'
      domain:
        extension: london
        name: test4
      easydmarc_email_address: ''
      expired_at: '2019-01-01 0:00:01'
      id: 123456789
      recent_easydmarc_action:
        message: ''
        recent_action: enabled
      record_host: ''
      record_type: ''
      record_value: ''
      renew_at: '2019-01-01 0:00:01'
      status: ''
  orderRetryEasyDmarcResponse:
    type: object
    title: RetryEasyDmarcResponse
    properties:
      code:
        type: integer
        format: int32
        title: Response code
      data:
        title: Response data
        $ref: '#/definitions/orderEasyDmarcOrder'
      desc:
        type: string
        title: Response description
      warnings:
        type: array
        title: Array of warning messages
        items:
          $ref: '#/definitions/errorWarning'
    example:
      code: 0
      data:
        activated_at: '2019-01-01 0:00:01'
        domain:
          extension: london
          name: test4
        easydmarc_email_address: ''
        expired_at: '2019-01-01 0:00:01'
        id: 123456789
        recent_easydmarc_action:
          message: ''
          recent_action: enabled
        record_host: ''
        record_type: ''
        record_value: ''
        renew_at: '2019-01-01 0:00:01'
        status: ''
      desc: ''
  errorError:
    type: object
    title: Error
    properties:
      code:
        type: integer
        format: int32
        title: Error code
      data:
        type: string
        title: Additional error description
      desc:
        type: string
        title: Error description
    example:
      code: 0
      data: ''
      desc: ''
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
    x-linkTo: tag/descAuthentication
x-tagGroups:
- name: Introduction
  tags:
  - descAbout
  - descGettingStarted
  - descEndpoints
  - descAuthentication
- name: Quick Start
  tags:
  - descCustomerQuickstart
  - descDomainQuickstart
  - descTLDQuickstart
  - descDNSQuickstart
  - descSSLQuickstart
- name: Auth
  tags:
  - Auth
  - SpamExpert
- name: Billing
  tags:
  - InvoiceService
  - Payment
  - Transaction
- name: DNS
  tags:
  - DomainToken
  - NameserverService
  - NsGroupService
  - TemplateService
  - ZoneService
  - ZoneRecordService
- name: Domain
  tags:
  - DomainService
  - AdditionalData
  - CustomerAdditionalData
  - DomainPriceService
  - AuthCode
  - TldService
- name: EasyDmarc
  tags:
  - EasydmarcOrder
- name: Email template
  tags:
  - Email
- name: License
  tags:
  - LicenseService
- name: Reseller/Customer
  tags:
  - ContactService
  - Customer
  - EmailVerification
  - ResellerService
  - Settings
  - Statistics
  - TagService
- name: Spam Experts
  tags:
  - SEDomain
- name: SSL
  tags:
  - ApproverEmail
  - Csr
  - Order
  - OrderApproverEmail
  - OtpToken
  - Product