OAuth Configuration

Define Your Auth Process

You will need to start by defining your auth process as being an oauth type of auth process. This is done by setting the AuthProcess.Identifier.AuthenticationType = AuthenticationType.OAuth.

import {
AuthenticationType,
AuthSpecification,
OrderSourceAppMetadata,
} from "@shipengine/connect-order-source-api";
export const AuthProcess: AuthSpecification = {
Identifier: {
AuthenticationType: AuthenticationType.OAuth,
IsSandbox: false,
},
...
};
export const Metadata: OrderSourceAppMetadata = {
// DO NOT CHANGE THIS ID AFTER PUBLISHING
Id: "bcce593b-dce3-4491-8722-a56e653c173f",
Name: "Example",
AuthProcess,
OrderSources: [Example],
};

The next step is to configure the rest of your AuthProcess to describe how the ShipEngine Connect platform will handle the oauth workflow. We currently support two flavors of oauth, more details can be found at the following links:

Publish

The next step will be to publish your application using the connect publish command.

Request An Installation

  • Contact a member of the ShipEngine Connect Team in order to establish a the platform installation
    • Provide a ClientId & ClientSecret used for initiating the oauth workflow
  • Once the installation has been created you will recieve back a callback url

Test

You are ready to begin testing your OAuth workflow, login with the credentials provided to you during the connect publish step, and go initiate your connection workflow.

Examples

IntegrationAuth VersionDetails
eBayOAuth 2custom installation properties, base64 encoding installation properties
GoogleOAuth 2uses result_token_response
Trade MeOAuth 1uses auth1 redirector, uses response transformation