Get Started
Quickstart
Call a third-party API through Alter in under 10 minutes.
By the end of this quickstart, an app key will be minted, Slack will be connected, and a message will be posted from application code — with no token ever touching that code.
Total time: about 10 minutes.
Sign up
Create a free account at portal.alterauth.com.
Create an app
In the portal sidebar, choose Apps → New App. Name it quickstart and click Create.
An app is the unit that owns API keys, provider configuration, and grants. See Apps & Organizations for the full model.
Mint an API key
Open the new app, go to API Keys → Mint key, copy the value, and export it:
export ALTER_API_KEY="alter_rk_..."The plaintext is shown once. If lost, mint a new key and revoke the old one.
Install the SDK
pip install alter-sdknpm install @alter-ai/alter-sdkPython 3.10+. Node 20+.
Connect Slack
Run the snippet below once. It opens a browser, walks through the Slack OAuth flow, and prints the grant_id used in the next step.
import asyncio, osfrom alter_sdk import App
async def main(): app = App(api_key=os.environ["ALTER_API_KEY"]) results = await app.connect(providers=["slack"]) print("grant_id:", results[0].grant_id) await app.close()
asyncio.run(main())import { App } from "@alter-ai/alter-sdk";
const app = new App({ apiKey: process.env.ALTER_API_KEY! });try { const results = await app.connect({ providers: ["slack"] }); console.log("grantId:", results[0].grantId);} finally { await app.close();}Export the printed grant ID:
export SLACK_GRANT_ID="<the printed grant id>"Post a Slack message
Replace #general with an accessible channel.
import asyncio, osfrom alter_sdk import App, HttpMethod
async def main(): app = App(api_key=os.environ["ALTER_API_KEY"]) response = await app.request( HttpMethod.POST, "https://slack.com/api/chat.postMessage", grant_id=os.environ["SLACK_GRANT_ID"], json={"channel": "#general", "text": "Hello from Alter."}, ) print(response.status_code, response.json()) await app.close()
asyncio.run(main())import { App, HttpMethod } from "@alter-ai/alter-sdk";
const app = new App({ apiKey: process.env.ALTER_API_KEY! });try { const response = await app.request( HttpMethod.POST, "https://slack.com/api/chat.postMessage", { grantId: process.env.SLACK_GRANT_ID!, json: { channel: "#general", text: "Hello from Alter." }, }, ); console.log(response.status, await response.json());} finally { await app.close();}Check Slack. The message is there.
See the audit row
Open Audit Logs in the portal. Every Alter call shows the caller, the principal, the provider, the response status, and the latency.
What just happened
Section titled “What just happened”app.request() resolved the Slack grant, fetched a fresh token from the vault, injected it into the outgoing Slack call, and wrote the audit row. No token was ever stored, refreshed, or seen by application code.