weBump Platform API preview
Developer preview: reviewed projects, explicit player approval, scoped bearer tokens, game-defined private JSON saves, separately opted-in selected shared…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Developer preview: reviewed projects, explicit player approval, scoped bearer tokens, game-defined private JSON saves, separately opted-in selected shared JSON, public showcases and eligible visitors. Public client IDs are not secrets: copying configuration can initiate a request but cannot alone access protected player data. Redirect callbacks protect code delivery with PKCE, not the origin of later API requests. Reviewed device grants authorize the device the player confirms; neither method attests an official app binary. CORS is not client authentication. See https://developer.webump.app/tutorial#security-model. Rate-limit budgets and retry guidance: https://developer.webump.app/rate-limits.html.
Endpoints 35
- GETBegin five-minute phone approval request
/oauth/authorize?client_id=string&redirect_uri=https://example.com&response_type=code&state=string&code_challenge=string&code_challenge_method=S256&scope=string - POSTRedeem a callback code, poll device approval, or rotate a refresh token
/oauth/tokenSupports authorization_code + S256 PKCE, rotating refresh_token, and urn:ietf:params:oauth:grant-type:device_code with client_id/device_code. Device polling… - POSTDisconnect the token owner from this project; unknown tokens succeed
/oauth/revoke - GETProject-specific player ID and permitted own card
/v1/me - GETEffective scopes and player-controlled sharing choices
/v1/me/permissions - GETRead state and the shared document revision
/v1/me/stateRequires game.state. - PUTReplace state conditionally
/v1/me/state/:keyRequires game.state. - DELETEDelete state conditionally
/v1/me/state/:keyRequires game.state. - GETRead capsule and the shared document revision
/v1/me/capsuleRequires game.capsule. - PUTReplace capsule conditionally
/v1/me/capsuleRequires game.capsule. - DELETEDelete capsule conditionally
/v1/me/capsuleRequires game.capsule. - GETRead showcase and the shared document revision
/v1/me/showcaseRequires game.showcase. - PUTReplace showcase conditionally
/v1/me/showcaseRequires game.showcase. - DELETEDelete showcase conditionally
/v1/me/showcaseRequires game.showcase. - POSTOptional: player-chosen transfer of specific receipts (GET /v1/me/visitors lists eligible visitors automatically)
/v1/me/visitor-handoffRequires visitors.receive. - GETRefresh a previously handed-off card; no arbitrary people lookup
/v1/me/visitors/:referenceRequires visitors.receive. - DELETEDelete game data, pairwise ID and all grants; keep the local game save
/v1/me/game-data - POSTList own connected games and available recipients
/app/v1/platform-games - POSTSet global visitor-card sharing
/app/v1/platform-preferences - POSTExclude or allow a project to receive your visitor card
/app/v1/platform-exclusion - POSTDisconnect, delete or change own game sharing
/app/v1/platform-manage - POSTRead immutable request details before presenting approval
/app/v1/platform-request - POSTExplicitly approve or deny the bound request
/app/v1/platform-decision - POSTAccept a fresh rolling ID and return local receipt references
/app/v1/platform-encounter - GETRead an approved game icon
/v1/assets/:hash.pngServes metadata-stripped static PNG only for an active approved project. No authentication or tracking URLs. - POSTList publicly shared game cards on a profile (first-party app only)
/app/v1/platform-profile-gamesRequires installation authentication. Returns only explicitly published showcase fields from active projects and player grants. Bilateral blocks, suspension… - GETRead your selected shared-data document
/v1/me/sharedRequires game.shared in both the approved project and player grant. Conditional mutations use the same revision as private state, capsule and showcase. Absent… - PUTExplicitly publish selected game data
/v1/me/sharedRequires game.shared in both the approved project and player grant. Conditional mutations use the same revision as private state, capsule and showcase.… - DELETEErase only your published shared copy
/v1/me/sharedRequires game.shared in both the approved project and player grant. Conditional mutations use the same revision as private state, capsule and showcase. Keeps… - GETRetrieve selected shared data through an authorized visitor reference
/v1/me/visitors/:reference/sharedRequires game.shared and visitors.receive. Reference must belong to this player grant, be redeemed, released and unexpired. The source needs a current… - GETPublic authorization status only
/oauth/pendingStatus only for all callers, including legacy POST and peek. Never returns codes, callback URLs, tokens or private device credentials. Does not register a… - POSTPublic authorization status only
/oauth/pendingStatus only for all callers, including legacy POST and peek. Never returns codes, callback URLs, tokens or private device credentials. Does not register a… - GETList the player's eligible visitors
/v1/me/visitorsRequires visitors.receive. Returns the people this player bumped, including verifiable recent history synced by weBump whose bump is unwrapped and reveal… - GETQR code for an approval request
/oauth/qrSupply exactly one request reference (redirect flow) or user_code (device flow). Returns image/svg+xml encoding the public approval link for a live request.… - POSTStart an explicitly reviewed public-client device connection
/oauth/device_authorizationRequires device_code in project.connection_methods. No callback or PKCE parameters. Display user_code on the requesting device and require matching…
API details
- Base URL
https://api.webump.apphttps://winnie.taila760d9.ts.net:8443- Authentication
- A bearer token in the Authorization header
An API key in the x-webump-installation-id header
An API key in the x-webump-installation-secret header - Operations
- 35 operations on 27 pathsGET 13POST 13DELETE 5PUT 4
- Response formats
application/jsonimage/pngimage/svg+xml- Description format
- OpenAPI 3.1.0, API version
2026-09-19 - Links
- OpenAPI document
- Listed from
- Webump's published OpenAPI description
How to test the weBump Platform API preview in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the weBump Platform API preview collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Begin five-minute phone approval request” (GET /oauth/authorize?client_id=string&redirect_uri=https://example.com&response_type=code&state=string&code_challenge=string&code_challenge_method=S256&scope=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the weBump Platform API preview?
Developer preview: reviewed projects, explicit player approval, scoped bearer tokens, game-defined private JSON saves, separately opted-in selected shared… It is listed under Media & content and has 35 endpoints.
Who publishes the weBump Platform API preview?
It is listed from weBump's public API description (an OpenAPI document), not published by weBump on Swastik Codes. Anyone who controls webump.app can claim the profile by adding a DNS TXT record.
What is the base URL of the weBump Platform API preview?
Its description lists 2 base URLs: https://api.webump.app, https://winnie.taila760d9.ts.net:8443. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the weBump Platform API preview?
It accepts 3 methods: A bearer token in the Authorization header; an API key in the x-webump-installation-id header; an API key in the x-webump-installation-secret header.
How many endpoints does the weBump Platform API preview have?
35 operations on 27 paths (13 GET, 13 POST, 5 DELETE, 4 PUT).
Is forking the weBump Platform API preview free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.