Restaurant365 Authentication API

openapi: 3.2.0
info:
  title: R365 Authentication API
  description: The R365 API lets approved third-party services and vendors connect to a Restaurant365 customer database to retrieve data and push records, including accounts payable (AP) invoices and general ledger (GL) entries. Each request is authenticated with a bearer token obtained from the Authenticate operation. Access is provisioned per customer by contacting R365 Support to enable a vendor. All paths are served from the customer's unique R365 database host.
  version: v1
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: Proprietary
servers:
- url: https://{customerHost}.restaurant365.com
  description: Customer-specific Restaurant365 database host
  variables:
    customerHost:
      default: yourcompany
      description: The unique customer subdomain assigned by Restaurant365
tags:
- name: Authentication
  description: Obtain a bearer token for subsequent requests
paths:
  /APIv1/Authenticate:
    post:
      operationId: authenticate
      summary: Authenticate And Obtain Bearer Token
      description: Exchange an R365 username and password for a bearer token that must be sent in the Authorization header on all subsequent API requests.
      tags:
      - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationRequest'
      responses:
        '200':
          description: Authentication succeeded; bearer token returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationResponse'
        '401':
          description: Invalid credentials
components:
  schemas:
    AuthenticationRequest:
      type: object
      required:
      - UserName
      - Password
      properties:
        UserName:
          type: string
          description: R365 username
        Password:
          type: string
          description: R365 password
    AuthenticationResponse:
      type: object
      properties:
        SessionId:
          type: string
          description: Identifier for the authenticated session
        UserName:
          type: string
          description: Authenticated R365 username
        BearerToken:
          type: string
          description: Bearer token to send in the Authorization header
        ResponseStatus:
          type: object
          description: Response status object; empty on success
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token returned by the Authenticate operation