Skip to content
techrace/
TECHRACE DOCUMENTATION

Your first integration

Connect one customer, with the smallest permissions your product needs.

1. Create your developer project

Sign in with your work email or Google, verify your authenticator, then create a project. You become its owner. A project contains your team, API keys, downstream customer records and billing. Sign-in requires the deployment to be configured.

2. Create a server API key

Expand Developer tools and open API keys as a verified owner or administrator and select only the scopes your backend needs. Current role, email and MFA are rechecked when saving. Copy the secret once into your secret manager. Never expose it in a browser, mobile app, URL, repository or AI prompt. If creation times out, inspect the key list before creating a replacement.

3. Register your return URL

An owner or admin adds an exact HTTPS return URL in Developer tools → App settings. Wildcards and arbitrary redirect destinations are not accepted.

4. Add a customer and request consent

Create a customer using your own authenticated customer ID as external_id. Request a connection session for an enabled provider. Redirect that customer to the returned URL so they can review the provider permissions and select an eligible account. Facebook Page and YouTube channel discovery follows bounded pagination; oversized or incomplete sets return an error instead of silently hiding later accounts.

5. Check the connection

List connections for the same project and customer. Use the connection ID for an implemented operation. A catalog listing alone does not mean the provider is enabled or approved.

6. Handle results

Read the operation receipt and verify signed event deliveries. Treat ambiguous mail sends as uncertain; do not submit a replacement automatically. Test revocation, cancellation and errors before launch.

// Server only · use the SDK supplied with Techrace.
import { TechraceClient } from './sdk/client';
const techrace = new TechraceClient({
  baseUrl: process.env.TECHRACE_API_URL,
  projectId: process.env.TECHRACE_PROJECT_ID,
  apiKey: process.env.TECHRACE_API_KEY,
});

const customer = await techrace.createCustomer({
  external_id: authenticatedCustomer.id,
  name: authenticatedCustomer.name,
});

const connection = await techrace.createConnectSession({
  customer_id: customer.customer.id,
  provider: 'gmail',
  return_url: 'https://your-app.com/connected',
});

// Your customer reviews the provider consent screen.
redirect(connection.url);
ILLUSTRATIVE · USE YOUR VERIFIED DEPLOYMENTServer-side only
Check your deployment

These guides describe implemented code and operating requirements. Enabled capabilities and permissions may differ. Use the current API specification and your project’s capability view.

OpenAPI specification