Quickstart

Make your first authenticated call in a few minutes. You'll exchange your client credentials for an access token, then read the client and its campaigns.

1. Get your credentials

Your Framme contact issues a client_id and client_secret for your shop, per environment. Keep the secret server-side — never ship it in a browser or mobile app.

Don't have credentials yet? Email tech@framme.com to set up a sandbox — see Environments.

2. Get an access token

Exchange your credentials at the token endpoint (OAuth2 client-credentials).

curl -X POST https://api.development.platform.framme.com/public/v1/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=$FRAMME_CLIENT_ID" \
  -d "client_secret=$FRAMME_CLIENT_SECRET"

# → { "access_token": "…", "token_type": "Bearer", "expires_in": 3600 }

3. Call the API

Send the token as a Bearer credential. Confirm who you are, then list your shop's campaigns.

curl https://api.development.platform.framme.com/public/v1/me \
  -H "Authorization: Bearer $TOKEN"

curl https://api.development.platform.framme.com/public/v1/campaigns/store \
  -H "Authorization: Bearer $TOKEN"