API Client

Test any RevKeen API endpoint interactively without writing code. Import the OpenAPI spec into your preferred tool and start making requests.

Scalar API Client

The recommended way to test the RevKeen API is with the Scalar API Client -- a browser-based REST client built specifically for OpenAPI specs.

Features:

• Auto-loads all endpoints, schemas, and examples from the spec
• Environment switching (Sandbox / Production)
• Authentication pre-fill with your API key
• Response inspection with headers, body, and timing
• Request history and collections
• Dark mode

Quick start:

1. Open client.scalar.com
2. Import spec: https://api.revkeen.com/v2/openapi.json
3. Set authentication: x-api-key header with your rk_sandbox_ key
4. Select an endpoint and click Send

Built-in API Reference

The interactive API reference includes a built-in Try-it console. Every endpoint has a Send Request button that lets you:

• Edit request parameters and body inline
• Switch between Sandbox and Production environments
• View the full response with status code, headers, and body
• Copy generated code snippets in TypeScript, Python, PHP, Go, curl, and more

Open the interactive reference

Import Into Your Tools

The OpenAPI specification can be imported into any tool that supports OpenAPI 3.1.

Spec URL: https://api.revkeen.com/v2/openapi.json

Postman

1. Open Postman and click Import
2. Select Link and paste: https://api.revkeen.com/v2/openapi.json
3. Click Import -- all endpoints are created as a collection
4. Set up an environment variable api_key with your rk_sandbox_ key
5. In the collection settings, add x-api-key: {{api_key}} as a default header

Insomnia

1. Open Insomnia and go to Import/Export
2. Select From URL and paste: https://api.revkeen.com/v2/openapi.json
3. The collection is created with all endpoints organized by tag
4. Set your API key in the environment configuration

Bruno

1. Open Bruno and click Import Collection
2. Select OpenAPI V3 as the format
3. Paste the spec URL or upload the downloaded JSON file
4. Configure the x-api-key header in the collection-level settings

curl

No import needed -- use curl directly:

# List customers
curl https://sandbox-api.revkeen.com/v2/customers \
  -H "x-api-key: rk_sandbox_your_key"

# Create a customer
curl -X POST https://sandbox-api.revkeen.com/v2/customers \
  -H "x-api-key: rk_sandbox_your_key" \
  -H "Content-Type: application/json" \
  -d '{"email": "test@example.com", "name": "Test Customer"}'

HTTPie

# List customers
http GET https://sandbox-api.revkeen.com/v2/customers \
  x-api-key:rk_sandbox_your_key

# Create a customer
http POST https://sandbox-api.revkeen.com/v2/customers \
  x-api-key:rk_sandbox_your_key \
  email=test@example.com name="Test Customer"

Authentication Setup

All API requests require an API key in the x-api-key header.

Related