Skip to main content

Portal Advanced Features

Beyond API discovery and subscriptions, the Developer Portal provides tools for testing, automation, and usage monitoring.

API Testing Sandbox​

Test API endpoints directly from the Portal without external tools.

Features​

FeatureDescription
Method selectorGET, POST, PUT, PATCH, DELETE
Path builderAuto-complete from API spec
Header editorAdd custom headers
Body editorJSON editor with syntax highlighting
Auth injectionAutomatic Bearer token or API key
Response viewerStatus, latency, formatted JSON/text
Request historyRecent requests for quick replay

Using the Sandbox​

  1. Navigate to an API detail page
  2. Click Try It or Sandbox
  3. Select the HTTP method and path
  4. Add headers or body as needed
  5. Choose the environment (dev, staging, production)
  6. Click Send

Environment Selection​

The sandbox supports multiple environments:

EnvironmentBase URLUse Case
DevelopmentConfigured per APILocal testing
StagingStaging gateway URLPre-production validation
ProductionProduction gateway URLLive verification

Switch environments using the dropdown at the top of the sandbox.

Authentication​

The sandbox automatically injects credentials based on your subscription:

  • Bearer token: Uses your current session token
  • API key: Uses the key from your active subscription

Webhook Management​

Manage webhook endpoints for subscription event notifications.

Creating a Webhook​

  1. Navigate to Webhooks in the Portal sidebar
  2. Click Create Webhook
  3. Enter the target URL (HTTPS required in production)
  4. Select event types to subscribe to
  5. Enter a signing secret (minimum 32 characters)
  6. Click Save

Delivery History​

View the delivery status of each webhook event:

StatusBadgeMeaning
successGreenEndpoint returned 2xx
pendingYellowDelivery in progress or scheduled retry
failedRedAll retry attempts exhausted

Click a delivery to see the full request/response details including response body and headers.

Testing​

Click Test on any webhook to send a synthetic event. The test payload includes "test": true for identification.

Retry Failed Deliveries​

Click Retry on a failed delivery to re-send the event immediately.

See Webhooks for the full webhook API reference and signature verification examples.

Service Account Management​

Create and manage service accounts for M2M API access.

Creating a Service Account​

  1. Navigate to Service Accounts in the Portal sidebar
  2. Click Create Service Account
  3. Enter a name and optional description
  4. Click Create
  5. Copy the credentials immediately — the secret is shown only once

Available Actions​

ActionDescription
CreateGenerate new client_id + client_secret
DeleteRemove account and invalidate all tokens
Regenerate secretNew secret, old one invalidated immediately

Service accounts inherit the RBAC role of the user who created them.

See Service Accounts for usage patterns and CI/CD integration.

Usage Analytics​

Monitor your API consumption from the Usage page.

Metrics Available​

MetricDescription
Total requestsCumulative requests across all subscriptions
Requests by APIPer-API breakdown
Error ratePercentage of 4xx/5xx responses
Latency distributionResponse time percentiles
Quota usageCurrent usage vs. rate limit

Time Ranges​

Select from 24h, 7d, or 30d views to track consumption trends.

Workspace Settings​

Manage your workspace from the Workspace page:

  • Profile: Update display name and contact email
  • Notifications: Configure email notification preferences
  • API keys: View and manage active API keys across subscriptions
  • Team members: Invite collaborators to your workspace (tenant-admin only)

MCP Server Discovery​

Browse available MCP servers and AI tools:

  1. Navigate to Servers in the Portal sidebar
  2. Browse available MCP servers by category
  3. View server details: tools offered, authentication requirements, pricing tier
  4. Click Subscribe to request access to a server's tools

Consumer Registration​

Self-service registration for new API consumers:

  1. Navigate to Register from the Portal home page
  2. Fill in organization details and use case
  3. Submit the registration request
  4. Wait for admin approval (notification sent via email)
  5. Once approved, access the API catalog and create subscriptions