Total Expert Authentication API

openapi: 3.2.0
info:
  title: Total Expert Public Authentication API
  version: v1
  description: The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.
  contact:
    url: https://developer.totalexpert.net
servers:
- url: https://public.totalexpert.net
  description: Total Expert external API — production
- url: https://public.vt.totalexpert.net
  description: Total Expert external API — development/sandbox domain (isolated from live data; per the Vendor OAuth Integration Guide)
security:
- oauth2: []
tags:
- name: Authentication
paths:
  /v1/token:
    post:
      operationId: fetchATokenFromClientCredentialsGrant
      summary: Fetch a Token From Client Credentials Grant
      description: 'Supply client credentials to obtain an access token.


        If you are integrating with the Total Expert API from a confidential client you will likely want to use this endpoint. For the client_credentials authorization grant type you will need to make certain that your client is also the resource owner.


        Authorization Header Encoding


        Shown in the HEADERS table below, the Authorization header field implements the Basic Authentication Schema. The ''basic_auth'' value needs to be a base64-encoded string containing your client_id and client_secret. The string that you encode must be in the format:


        yourclientid:yourclientsecret


        The following are examples of methods that can be used to base64-encode a string.


        On BSD/Linux/Mac run:


        echo -n ''yourclientid:yourclientsecret'' | openssl base64


        (note - this often injects one or more newlines into the encoded string, remove it before using to authenticate)


        For Windows see:


        https://support.microsoft.com/en-us/kb/191239


        Using The Token


        To interact with the secure endpoints in the TE API, supply the token in the ''Authorization'' header as ''Bearer {Token}''


        Alternate documented request: Fetch a Token From Authorization Code.


        Alternate documented request: Refresh a Token.'
      tags:
      - Authentication
      responses:
        '200':
          description: Fetch a Token (scopes defined)
          content:
            application/json:
              example:
                access_token: 407573dd426fe03eec4c63064a4bfbe9525107fa
                expires_in: 3600
                token_type: bearer
                scope: leadInteraction
        '400':
          description: Invalid credentials
          content:
            application/json:
              example:
                error: invalid_client
                error_description: The client credentials are invalid
      requestBody:
        content:
          application/json:
            examples:
              default:
                value:
                  grant_type: client_credentials
              fetch-a-token-from-authorization-code:
                value:
                  grant_type: authorization_code
                  code: '{{authorization_code}}'
                  redirect_uri: '{{redirect_uri}}'
              refresh-a-token:
                value:
                  grant_type: refresh_token
                  refresh_token: '{{refresh_token}}'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0. Obtain a token from POST /v1/token using HTTP Basic (client_id:client_secret base64-encoded) plus a grant_type body. Access tokens are bearer tokens, expires_in 3600.
      flows:
        clientCredentials:
          tokenUrl: https://public.totalexpert.net/v1/token
          scopes:
            crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
            leadInteraction: Lead interaction access (documented in the collection token examples)
            loanInteraction: Loan interaction access (documented in the collection token examples)
            leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
            postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
        authorizationCode:
          authorizationUrl: https://public.totalexpert.net/v1/authorize
          tokenUrl: https://public.totalexpert.net/v1/token
          refreshUrl: https://public.totalexpert.net/v1/token
          scopes:
            crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
            leadInteraction: Lead interaction access (documented in the collection token examples)
            loanInteraction: Loan interaction access (documented in the collection token examples)
            leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
            postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
externalDocs:
  description: Total Expert Public API documentation (Postman)
  url: https://documenter.getpostman.com/view/1929166/total-expert-public-api/6Z2RYyU