Quickstart

The SimpleLinks Plugin API powers Steam ↔ Discord account binding, role syncing, and Oxide/Carbon permission integration on your game servers. This guide gets you from zero to a working API call in three minutes.

Heads up. API keys are auto-generated the moment you create a Server in the dashboard. You do not need to (and cannot) create one manually — one Server equals one permanent API key.

1. Create a Server

Sign in to the Dashboard, pick your Discord guild, and add a Server. Each Server represents a single game instance (e.g. EU Main, NA PvE). On creation, an API key is minted automatically and shown to you once.

2. Find your API key

Open the Server detail page. The API Key card shows the prefix and offers a one-click Copy. If you lose the key, click Regenerate — the old key stops working instantly and the new one is shown.

Treat keys like passwords. Never commit them to a public repo, paste them in screenshots, or send them in plain chat. If a key leaks, regenerate it from the dashboard.

3. Make your first call

Every Plugin API call goes to https://simplelinks.cc/api with an action query parameter and an authentication header. Here's a Steam-to-Discord lookup:

curl "https://simplelinks.cc/api?action=findBySteam&id=76561198000000000" \
  -H "X-API-Key: sl_live_abc123…"

Successful response:

"349279096745754624"

4. Next steps

Read the Authentication page to learn about request signing and header formats.
Browse the Lookup Actions reference for every read endpoint.
See the Rate Limits guide for per-tier throughput.