Connect your developer portal

What you can show

Each card is read for the levels marked below, and only when the key carries its scope. A card asked for a level it is not read for answers 400.

To read several cards at once, /v1/entity/<level>/<id> returns every card the entity is read for and the key carries, in one response. /v1/entities returns every organization, unit, team, area and repository with the lighter cards, for a portal that syncs the whole company; Compliance, AI, People and cost, Initiatives, Bugs and Incidents are read one entity at a time.

Before you start

1. Create a key

1. In ScaleQuality, open Developers and choose the API tab.
2. Press Create key and name it after where it runs, for example Backstage production.
3. Leave Share people cost and initiatives unchecked, unless the portal should show those two cards.
4. Copy the key. It starts with sq_live_.

2. Find your ids

Every call names a level and an id. The catalog lists your organization, its business units, teams, business areas and repositories, each with its id.

curl https://app.scalequality.io/v1/catalog \
  -H "Authorization: Bearer sq_live_..."

In the app, Developers, IDP shows the call of each card for the entity you pick, and a dashboard's Take it to the IDP lists the calls of all its cards.

3. Connect your portal

Pick the portal you run. The steps above are the same for all three.

# from your Backstage app root
yarn --cwd packages/app add @scalequality/backstage-plugin@^0.3.0

proxy:
  endpoints:
    '/scalequality':
      target: https://app.scalequality.io/v1
      changeOrigin: true
      headers:
        Authorization: 'Bearer ${SCALEQUALITY_API_KEY}'

import { EntityScaleQualityCard } from '@scalequality/backstage-plugin';

<Grid item md={6}>
  <EntityScaleQualityCard />
</Grid>

metadata:
  annotations:
    scalequality.io/repo-id: <project-uuid>
    # or: scalequality.io/team-id, area-id, bu-id or org-id

Reference

Endpoints

Parameters

Errors

Troubleshooting