Skip to main content

​
Quickstart

This first-release quickstart is intentionally compact. The goal is to get an integration team from credentials to a successful request and then into the full API Reference and Playground.

​
1. Get environment-specific credentials

Request BLIPS credentials for the environment you are targeting. The current public contract uses Basic Auth in the form: 
clientId:clientSecret

​
2. Confirm the target server

The local OpenAPI file currently carries a placeholder public host so the docs source can be prepared before production infrastructure is frozen. Before public launch, replace the placeholder servers value with the real BLIPS sandbox and production hosts. Mintlify needs this to enable full interactive Playground requests.

​
3. Make a first authenticated request

Use the platform configuration route as the first connectivity check: 
curl -u "$BLIPS_CLIENT_ID:$BLIPS_CLIENT_SECRET" \
  https://api.blips.example/config
Once the real public host is available, this should return the current platform configuration for the authenticated integration.

​
4. Move into the API flow you need

After connectivity is confirmed, the usual first branches are:
  • token management
  • customer onboarding
  • external account binding
  • same-currency transfers
  • lookup, quote, and execute flows
  • transaction review and lifecycle readback

​
5. Use the Playground for request testing

When the servers field points at real BLIPS hosts, Mintlify can use the OpenAPI document to generate request builders, auth inputs, and live Try it flows directly from the reference pages.