Skip to content

Overview

The public API for apps built on Blupinta: a home dashboard, another developer’s service. An app reads what the person allowed it, with an access token from auth.blupinta.app (OAuth 2.1 and OpenID Connect). A device without a keyboard uses the device flow (https://auth.blupinta.app/oidc/device/auth, client device, no registration); an app with a browser uses the authorization code with PKCE. Every request carries the token as Authorization: Bearer …. /v1 only grows: fields and operations may be added, never removed or changed.

The guide for developers

Information

  • License: Apache-2.0
  • OpenAPI version: 3.1.0

Tokens from auth.blupinta.app for the resource https://api.blupinta.app/v1. Devices may also use the device flow (RFC 8628) at /oidc/device/auth.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://auth.blupinta.app/oidc/authorize

Token URL: https://auth.blupinta.app/oidc/token

Refresh URL: https://auth.blupinta.app/oidc/token

Scopes:

  • projects:read - The saved versions of the projects the person chose
  • projects:write - Saving new versions of those projects, uploading files to them, renaming them
  • projects:create - Creating projects in the person’s account, which the app may then read and write
  • comments:read - The comments on those projects: their threads and messages
  • comments:write - Commenting on those projects as the person: opening threads, answering, resolving them
  • catalog:read - Blupinta’s catalog of products, searched and read whole, with its models and thumbnails
  • webhooks:manage - Being told, at an address of the app’s, what happens to the projects it reaches
  • hosts:manage - Declaring which parts of those projects the app uses, and its devices to bind