Wufoo Login API

Exchange credentials for an API key.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

wufoo-login-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wufoo REST Comments Login API
  description: 'The Wufoo REST API v3 provides programmatic read and write access to a Wufoo

    account: Forms, Fields, Entries, Reports, Widgets, Comments, Users, and

    Webhooks. Every request is per-subdomain and authenticates with the account

    API key over HTTP Basic Auth. Endpoints support `.json` or `.xml` response

    formats by appending the extension to the URL.

    '
  version: '3.0'
  contact:
    name: Wufoo Support
    url: https://help.surveymonkey.com/wufoo/
  license:
    name: Wufoo Terms of Use
    url: https://www.wufoo.com/terms-of-use/
servers:
- url: https://{subdomain}.wufoo.com/api/v3
  description: Wufoo account subdomain
  variables:
    subdomain:
      default: account
      description: Your Wufoo account subdomain.
security:
- basicAuth: []
tags:
- name: Login
  description: Exchange credentials for an API key.
paths:
  /login.{format}:
    post:
      tags:
      - Login
      summary: Exchange Credentials For API Key
      description: 'Builders integrating Wufoo for third-party customers can exchange a user''s

        email/password for that user''s API key.

        '
      operationId: login
      parameters:
      - $ref: '#/components/parameters/Format'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - email
              - password
              - integrationKey
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                  format: password
                integrationKey:
                  type: string
                subdomain:
                  type: string
      responses:
        '200':
          description: API key and subdomain for the user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ApiKey:
                    type: string
                  Subdomain:
                    type: string
components:
  parameters:
    Format:
      name: format
      in: path
      required: true
      description: Response serialization format.
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Auth. Use your Wufoo API key as the username and any non-empty

        string as the password. Servers require TLS v1.0 or higher; SSLv3 and lower

        are blocked.

        '