Before you begin: a configured deployment, verified owner/admin access and an enabled provider with the required permissions.
Sign in, complete MFA and create a developer project. Your project keeps team access, customers, keys and billing together.
Open your workspaceOwner or admin: open Developer tools → API keys. Select the minimum scopes, copy the secret once and store it in your server’s secret manager. Never expose it in a browser or AI prompt.
Open API keysOwner or admin: add your exact HTTPS return URL in Developer tools → App settings. Wildcards are not accepted.
Open app settingsCreate a customer with your authenticated customer ID as external_id. Request a connect session for an enabled provider and redirect that customer to its returned URL.
Read the API contractList connections for the same project and customer. Use the returned connection ID for a supported operation. Catalog entries alone do not mean a provider is enabled or approved.
Inspect connected accountsRead operation receipts and verify signed webhooks. Test revocation and cancellation. Ambiguous mail sends are uncertain: do not automatically submit a replacement.
Configure signed webhooks// 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);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