openapi: 3.2.0
info:
  title: Documentation Admin Other API
  version: '3.2'
  x-logo:
    altText: Affise API documentation.
    url: affise_logo.svg
    backgroundColor: '#fafafa'
  description: 'API 3.1 documentation.


    Authorization


    ```shell

    curl --header "API-Key:23df424b0a53b0899f78685966243ee61" http://YOUR_API_DOMAIN/

    or

    curl http://YOUR_API_DOMAIN/some_path?API-Key=23df424b0a53b0899f78685966243ee61

    ```



    For data exchange using authentication public key passed as parameter in the header API-Key. As the key, a hash generated for your site. API key, you can see in your profile.


    Find out more about where you can get your API URL, API-key and personal API-key for Affiliate here - [Getting Started with API](https://help-center.affise.com/en/articles/6463675-start-with-api-networks)


    Postman collection


    A ready-to-use Postman collection covering all endpoints of this documentation is available in the [affise-postman-api-collection](https://github.com/affise/affise-postman-api-collection) repository. Import the collection together with the Demo environment, set your `baseUrl` and API keys in the environment variables, and you are ready to send requests.


    <aside class="warning">

    All API requests must include an API-Key header or API-Key GET parameter for client authentication.

    </aside>

    '
servers:
- url: https://api-demo.affise.com
  description: Demo Server
  variables:
    api-key:
      default: 685168e94e6a96fa7c31895e
      description: Demo Test API Key
tags:
- name: admin-other
  x-displayName: Other
  description: Other admin endpoints — domains, currencies, custom fields, payment systems
paths:
  /3.1/browsers:
    get:
      tags:
      - admin-other
      summary: Browsers list
      description: '`GET /3.1/browsers`


        Get browsers list

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  browsers:
                    type: array
                    items:
                      type: string
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
              example:
                status: 1
                browsers:
                - Yahoo Mobile Messenger for Android
                - Dillo
                - lolifox
                - Facebook for Windows
                - Web Light
                - CometBird
                - MetaCert Safe iPad Browser
                pagination:
                  page: 1
                  per_page: 2147483647
                  total_count: 527
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.1/browsers' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.1/cities:
    get:
      tags:
      - admin-other
      summary: City list
      description: '`GET /3.1/cities`


        Get city list

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: country
        in: query
        description: Country code. Example US
        required: true
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: q
        in: query
        description: Search query
        schema:
          type: string
      - name: code
        in: query
        description: City codes for filter
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  cities:
                    type: array
                    items:
                      type: object
                      properties:
                        country_code:
                          type: string
                        id:
                          type: integer
                        name:
                          type: string
                        region_code:
                          type: string
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
              example:
                status: 1
                cities:
                - country_code: DE
                  id: 79729
                  name: Thallichtenberg
                  region_code: Rheinland-Pfalz
                - country_code: DE
                  id: 40034
                  name: Sindelfingen
                  region_code: Baden-Wurttemberg
                - country_code: DE
                  id: 75980
                  name: Hofkirchen
                  region_code: Bayern
                pagination:
                  page: 1
                  per_page: 2147483647
                  total_count: 3
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.1/cities?country=<country>' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/admin/currency:
    get:
      tags:
      - admin-other
      summary: Currency list
      description: '`GET /3.0/admin/currency`


        Get list of currency

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: get_only_active
        in: query
        description: Ignore inactive currencies
        schema:
          type: integer
          default: 0
          enum:
          - 0
          - 1
      - name: extended
        in: query
        description: Extended currencies information
        schema:
          type: integer
          default: 0
          enum:
          - 0
          - 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  quotes:
                    oneOf:
                    - type: object
                      additionalProperties:
                        type: number
                    - type: array
                      items:
                        type: object
                        properties:
                          _id:
                            type: integer
                          code:
                            type: string
                          active:
                            type: boolean
                          default:
                            type: boolean
                          rate:
                            type: number
                          min_payment:
                            type: integer
                          is_crypto:
                            type: boolean
                            nullable: true
              example:
                default:
                  value:
                    status: 1
                    quotes:
                      RUB: 59.312599
                      USD: 1
                      AED: 3.672497
                      AFN: 66.669998
                      ALL: 125.800003
                      AMD: 485.299988
                      ANG: 1.769851
                      AOA: 165.080994
                extended:
                  value:
                    status: 1
                    quotes:
                    - _id: 2
                      code: USD
                      active: true
                      default: true
                      rate: 1
                      min_payment: 20
                      is_crypto: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/admin/currency?get_only_active=0&extended=0' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/admin/custom_fields:
    get:
      tags:
      - admin-other
      summary: Custom fields list
      description: '`GET /3.0/admin/custom_fields`


        Get list of signup settings

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        required:
                          type: boolean
                        field_type:
                          type: string
                        field_values:
                          type: object
                          nullable: true
              example:
                status: 1
                fields:
                - id: 1
                  name: Skype
                  required: false
                  field_type: text
                  field_values: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/admin/custom_fields' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.1/devices:
    get:
      tags:
      - admin-other
      summary: Devices list
      description: '`GET /3.1/devices`


        Get list of devices

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  types:
                    type: array
                    items:
                      type: string
              example:
                status: 1
                types:
                - mediahub
                - mobile
                - ereader
                - console
                - tv
                - tablet
                - desktop
                - smartwatch
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.1/devices' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/admin/domains:
    get:
      tags:
      - admin-other
      summary: Domains list
      description: '`GET /3.0/admin/domains`


        Get domains

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  domains:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        use_https:
                          type: boolean
              example:
                status: 1
                domains:
                - url: domain1.com
                  use_https: false
                - url: domain2.com
                  use_https: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/admin/domains' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/admin/payment_systems:
    get:
      tags:
      - admin-other
      summary: Payment systems list
      description: '`GET /3.0/admin/payment_systems`


        Get list of payment systems

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  payment_systems:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        lang_label:
                          type: string
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              lang_label:
                                type: string
                              required:
                                type: boolean
                        currency:
                          type: string
                          nullable: true
              example:
                status: 1
                payment_systems:
                - id: 2
                  lang_label: Wire transfer
                  fields:
                  - id: 1
                    lang_label: IBAN/Account Number
                    required: true
                  - id: 2
                    lang_label: Swift/BIC-Code
                    required: true
                  - id: 3
                    lang_label: Bank name
                    required: true
                  - id: 4
                    lang_label: Bank address
                    required: true
                  currency: null
                - id: 3
                  lang_label: Webmoney WMZ
                  fields:
                  - id: 1
                    lang_label: WMZ
                    required: true
                  currency: AED
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/admin/payment_systems' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
components:
  responses:
    Forbidden:
      description: Forbidden - Access denied, insufficient permissions
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: integer
                example: 2
              message:
                type: string
                example: Auth Denied
    Unauthorized:
      description: Unauthorized - API key is missing or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: integer
                example: 2
              message:
                type: string
                example: Token is necessary
    InternalServerError:
      description: Internal Server Error - Server error, please contact administrator
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: integer
                example: 2
              message:
                type: string
                example: Server error, Please contact your administrator
x-tagGroups:
- name: Admin API
  tags:
  - admin-advertisers
  - admin-affiliates
  - admin-offers
  - admin-stats
  - admin-conversions
  - admin-users
  - admin-presets
  - admin-payments
  - admin-billing
  - admin-smartlinks
  - admin-tickets
  - admin-automation
  - admin-adcosts
  - admin-other
- name: Advertiser API
  tags:
  - advertiser-auth
  - advertiser-offers
  - advertiser-stats
- name: Affiliate API
  tags:
  - affiliate-profile
  - affiliate-offers
  - affiliate-stats
  - affiliate-postbacks
  - affiliate-conversions
  - affiliate-pixels
  - affiliate-smartlinks
  - affiliate-news
  - affiliate-other
- name: Resources
  tags:
  - resources