TextMaster's Developer Documentation
HomeApp
  • Welcome!
  • Quick Start
    • Postman
    • OpenAPI
  • Overview
    • Resources in the REST API
    • Authentication
    • Troubleshooting
    • Filters
    • Workflow
    • File uploads
    • Loop
  • Guides
    • Integrator best practices
  • Apps
    • About OAuth Apps
    • Building OAuth Apps
      • Creating an OAuth App
      • Authorizing OAuth Apps
      • Scopes for OAuth Apps
    • Managing OAuth Apps
      • Modifying an OAuth App
      • Deleting an OAuth App
  • Webhooks & Events
    • Webhooks
      • Creating webhooks
      • Configuring your server for webhooks
      • Securing webhooks
      • Troubleshooting webhooks
    • Events
  • Integrations
    • Akeneo
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
    • Salesforce Commerce Cloud
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
  • Reference
    • Abilities
    • Authors
    • Documents
    • Categories
    • Countries
    • Expertises
    • Glossaries
    • Languages
    • Levels
    • Locales
    • Preferred Authors
    • Projects
    • Project Templates
    • Negotiated Contracts
    • Support Messages
    • Transactions
    • Uploads
    • Users
    • Work Templates
Powered by GitBook
On this page

Was this helpful?

  1. Apps

About OAuth Apps

Learn how to build integrations with the TextMaster API.

PreviousIntegrator best practicesNextBuilding OAuth Apps

Last updated 2 years ago

Was this helpful?

Apps on TextMaster allow you to automate and improve your workflow. You can build integrations with the TextMaster API to let your clients order translation, copywriting or proofreading projects of their content.

Overview

OAuth2 is a protocol that lets external applications request authorization to private details in a user's TextMaster account without accessing their password. This is preferred over Signature Authentication because tokens can be limited to specific types of data and can be revoked by users at any time.

An OAuth App uses TextMaster as an identity provider to authenticate as the user who grants access to the app. When users grant an OAuth App access, they grant permissions to all projects they have access to in their account.

Building an OAuth App is a good option if you are creating more complex processes than a simple script can handle. Note that OAuth Apps are applications that need to be hosted somewhere.

Keep these ideas in mind when creating OAuth Apps:

  • An OAuth App should always act as the authenticated user across all of TextMaster

  • An OAuth App can be used as an identity provider by enabling a "Login with TextMaster" for the authenticated user.

  • An OAuth App should only request the permissions it requires to operate normally.

Tips: OAuth Apps should request only the permissions it is required to operate normally.

For more on OAuth Apps, see:

Building OAuth Apps
Managing OAuth Apps