Overview

FieldEdge Partners build public applications and integrations that FieldEdge Members can install from the FieldEdge Marketplace. Partners authenticate through an OAuth-based JWT system managed by the Marketplace and receive a sandbox environment for testing before going live.

Partner authentication differs from Member authentication because:

Apps are installed by FieldEdge Members, not the partner.

Apps must be created in the FieldEdge Marketplace.

The installation flow provides metadata (target_id) that identifies the Member Tenant.

The app must exchange this metadata for an access token after installation.

1. Sandbox & Testing (`target_id`)

When a partner begins integration work, FieldEdge will provide:

A sandbox environment

A sandbox target_id (FieldEdge Tenant ID)

This allows partners to test authentication and API calls before onboarding actual customers.

Partners should begin building and validating their integration using the sandbox target_id.

2. Building a Partner App in FieldEdge Marketplace

Partners create their applications in the Marketplace.

Step 1 — Log in to FieldEdge Marketplace

https://partners.fieldedge.com/

If you don't have an account, use the onboarding form to request access.

Step 2 — Navigate to Apps

Go to: Apps → Create New OAuth App

Step 3 — Provide App Details

When creating the app, you must enter:

App name

Type

Step 4 — Configure App Details

Go to:
Apps → {Your App} → Basic Info

Provide:

Install URL (Required)

Contact Email

Install URL Requirements


https://your-install-url.com/?target={customerorg_guid}&target_id={fieldedge-tenant-id}

Where:

target – Marketplace ID of the FieldEdge Marketplace Consumer

target_id – The FieldEdge Tenant ID (used for authentication)

Your app should store the target_id and use it to request access tokens.

Step 5 — Save the App

Once created, the Marketplace will generate:

client_id

client_secret

These credentials are used by your app during the OAuth client-credentials flow.

3. App Installation Flow

When customers install your application, FieldEdge Marketplace handles the installation sequence.

Installation Flow Summary

A FieldEdge customer installs the app.

Marketplace redirects to your app’s Install URL with metadata:


https://your-install-url.com/?target={customerorg_guid}&target_id={fieldedge-tenant-id}

Your app exchanges these values for an access token using:

client_id

client_secret

target_id

Your app completes setup:

Store the installation metadata

Link the FieldEdge tenant

Authenticate or configure the customer

Your app redirects users back to FieldEdge Marketplace (success or error).

4. Partner Token Request (After Installation)

Once the customer installs the app and your Install URL receives metadata, your app should request a JWT access token using:

client_id (from Marketplace)

client_secret (from Marketplace)

target_id (installation metadata → FieldEdge Tenant ID)

Here’s a clean Markdown version of that section:

Requesting a JWT Access Token

POST
https://fieldedge.withgobo.com/oauth/token

Headers


Content-Type: application/x-www-form-urlencoded

Body (form-encoded)

Send the parameters as application/x-www-form-urlencoded, not JSON.


client_id=<your-client-id>
client_secret=<your-client-secret>
target_id=<fieldedge-tenant-id>
grant_type=client_credentials

Example (cURL)

Success Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR...",
  "token_type": "Bearer",
  "expires_in": 28000
}

⚠️ Note: This endpoint expects application/x-www-form-urlencoded payloads. JSON request bodies are not supported.

5. Calling FieldEdge APIs

Include the JWT in the request header:

Authorization: Bearer <jwt-token>

Partner Authentication Guide

Overview#

1. Sandbox & Testing (target_id)#

2. Building a Partner App in FieldEdge Marketplace#

Step 1 — Log in to FieldEdge Marketplace#

Step 2 — Navigate to Apps#

Step 3 — Provide App Details#

Step 4 — Configure App Details#

Install URL Requirements#

Step 5 — Save the App#

3. App Installation Flow#

Installation Flow Summary#

4. Partner Token Request (After Installation)#

Requesting a JWT Access Token#

Headers#

Body (form-encoded)#

Example (cURL)#

Success Response#

5. Calling FieldEdge APIs#