Install
Set up your Frame account, your API keys, and an authenticated request that confirms everything works. The quickstart takes it from here.
1. Get your API keys
In the Frame Dashboard, create a secret key and a publishable key. Sandbox keys are prefixed sk_sandbox_ and pk_sandbox_; production keys are sk_production_ and pk_production_. Toggle environments in the dashboard at any time.
Set the secret key as an environment variable:
export FRAME_SECRET_KEY=sk_sandbox_...
Keep secret keys out of source control, browser code, and mobile binaries. Use publishable keys client-side; never the secret key.
2. Install an SDK (optional)
Calling the API with curl works fine, and the rest of getting-started uses curl. If you want an SDK, see Backend SDKs for the official Node, PHP, and Ruby clients.
3. Authenticate your first request
All requests use the Authorization: Bearer <secret_key> header over HTTPS. Confirm your keys work by calling GET/v1/transfers — a fresh account returns an empty data array.
curl https://api.framepayments.com/v1/transfers \
--header "Authorization: Bearer $FRAME_SECRET_KEY"
A 200 OK response means you're authenticated.
Next
- Quickstart — create your first transfer in five minutes
- Accept a payment — production-shape card charge with Frame.js