Console and accounts
The console
What the Aggre console at app.aggre.org does: sign in, accounts and organizations, API keys, usage, and a browser for the datasets.
The console is the web app at app.aggre.org. It is where people sign in, create API keys and organizations, watch usage, and look at the data before writing code.
Signing in#
Open the sign-in page and choose a provider. The providers on offer are Google, GitHub and Orbbit SSO, as configured for the deployment (the page shows exactly those). There is no password to create and no separate sign-up: your first sign-in creates your account.
- If you sign in with a second provider whose verified e-mail address matches your account, it is linked to the same account automatically. Providers that do not vouch for an address never merge anything.
- Under Settings you can link another sign-in method or unlink one (one must remain), and delete your account.
- An app session lasts up to 30 days and ends sooner after 14 days without use.
Accounts and handles#
Like a code-hosting site, everyone has a personal account, and can create or join organizations. Both live in one namespace of handles, and each is addressed by its handle: app.aggre.org/{handle}. Each account has its own API keys, usage and audit log. See Organizations.
Pages#
| Page | What you do there |
|---|---|
/{handle} | See an overview of a personal account or an organization. |
/{handle}/keys | Create, list and revoke API keys: API keys. |
/{handle}/usage | See requests per day and per key against the limits: Usage and audit log. |
/{handle}/members | Organizations: members, roles and invitations: Organizations. |
/{handle}/activity | The audit log (owners and admins). |
/{handle}/settings | Display name, handle rename, leave or delete an organization. |
/settings | Your sign-in methods and deleting your account. |
/orgs/new | Create an organization. |
/datasets, /datasets/{id} | Browse the catalogue and read candles and instruments: Browsing the data. |
/legal, /legal/{instrument_id} | Browse statutes with their provisions, licence and attribution. |
/docs/api, /docs/playground | An in-app API reference and a playground that sends real requests with your key. |
Platform administration#
admin.aggre.org is a separate dashboard for Aggre's platform staff (dataset health, source credentials, login providers, staff, audit). It is not part of the customer console and is not documented here.
Building your own client#
The console is a plain client of the accounts API and the data API. Anything it does for a signed-in person can be done by a program that holds a browser session; reading data does not need the console at all, only a key.
Source: content/console/overview.md