← Developers
Start here
QuickstartSDKAuthentication
Identity
Sign in with Shin ID
Access
EntitlementsUsage & Qualified Active Days
Money
Purchases & refundsWebhooksVerifying signatures
Selling
Importing a productGitHub importSelling without the SDKCurrencies and pricingBuy with Guiru from your own site
Operating
Integration diagnosticsErrors & rate limitsTestingMobile API
Reference
ReferenceVersioning & changesFor agents
Machine-readable
llms.txt
Reference

Reference

Every public endpoint, its credential and its shape, on one page.

IdentityAccessSellingEventsHealthScopes

Identity

GET/oauth/authorize
auth · browser session

Consent screen. client_id, redirect_uri, scope, state, code_challenge, code_challenge_method=S256.

POST/api/oauth/token
auth · client secret or PKCE verifier

grant_type=authorization_code only → { access_token, token_type, expires_in, scope }. Code lives 5 minutes, single use.

GET/api/v1/me
auth · gat_…

→ { id, handle, display_name, image, entitlement? }.

Access

GET/api/v1/entitlements?user_id=<uuid>
auth · gk_…

→ { product_id, user_id, active, type, source, ends_at, test_mode }.

POST/api/v1/usage
auth · gk_…

{ user_id, kind: session|heartbeat|activity } → { ok, counted, qualifying, test_mode }. With gk_…, usage is recorded only for someone currently signed in to your product with Shin ID or holding an entitlement to it (otherwise counted: false with a reason), and is never qualifying. With the person's gat_… token, user_id is not sent and the report qualifies.

Selling

GET/buy/<slug>?src=<where>&currency=<CCY>
auth · none (buyer signs in)

Buy with Guiru from your own site. Availability is checked server-side; the checkout is the store's. See the buy link.

GET/p/<slug>/badge
auth · none

The On Guiru badge as SVG; says *Not listed* the moment that becomes true.

Events

POSTyour endpoint
auth · guiru-signature

{ id, event, created_at, data }. Seven events (six real, plus webhook.test), at-least-once, 1m/5m/30m/2h/12h backoff.

Health

GET/api/health
auth · none

Liveness. /api/ready additionally checks the database.

Scopes

identityOAuth
Shin ID, handle, display name, avatar.
entitlementsOAuth
Adds entitlement to /api/v1/me — for your product only.
mobilefirst party
The Guiru app's surface. Not granted to third-party clients.
PreviousMobile APINextVersioning & changes
Guiru
AboutStoreHow Guiru worksQuality BarGSPGuiru MemberStatus
Buying
Buy with GuiruYour libraryRefundsBuyer termsTrust & safety
Builders
For buildersSubmit a productGuiru ProPricing & feesPromoteDeveloper docs
Help
Help centreYour libraryBuying & refundsHow a product gets listedHow ranking worksReport a problem
Legal
All policiesTermsPrivacyCookiesCreator PoolAffiliate disclosure
Your account
Account settingsSign in
Shin AI
Shin WebsiteKatsuiTrouble? Message Mario
Find your next favourite. Software, games and digital products on Guiru.Guiru Beta · Feedback© 2026 Shinai Tecnologias I.S.
Beta
StoreLibraryBuildersMember
Sign in
StoreSearchLibraryMemberSign in