Skip to main content

Getting Access to the Developer Portal

The Developer Portal uses a managed access model — there is no self-service registration. A platform admin must explicitly grant access before a consumer can sign in.

For platform admins: setting up portal access​

Before consumers can sign in, a platform admin must enable portal access for their client.

Step 1: Enable portal access on the client​

  1. Go to Clients in the management UI
  2. Open the client representing this consumer
  3. Click Edit
  4. Toggle Developer Portal access to enabled (has_portal_access)
  5. Add the consumer's email address(es) to the Authorized emails list
  6. Save

Step 2: Assign collections​

Make sure the client has at least one published collection assigned. Without collections, the consumer will sign in to an empty portal.

Step 3: Notify the consumer​

Tell the consumer the Developer Portal URL and their email address. They can now request a magic link.

For consumers: signing in​

Navigate to the Developer Portal URL and enter your email address on the sign-in page.

note

Your email must be in the authorized list on your client record. If you get an error, ask your platform admin to add your email.

Step 2: Check your email​

You'll receive an email with a sign-in link. Click the link to authenticate.

Under the hood, the portal flow is:

  1. Request link (/api/v1/developer-portal/request-link)
  2. Validate token (/api/v1/developer-portal/validate-token)
  3. Create authenticated portal session

The link is single-use and expires after a short time. If it expires, go back to the portal and request a new one.

Step 3: You're in​

After clicking the link, you're signed in and redirected to your API dashboard.

Switching profiles​

If your client has multiple profiles (e.g., sandbox and production), you can switch between them using the Profile selector in the portal header.

  • The selected profile determines which auth headers/token are pre-filled in the interactive testing console
  • Your profile selection is saved between sessions

Signing out​

Click your name or avatar in the top right corner and select Sign out.

Next steps​