Organization integrations

The Discord and Game proxy pages connect your organization to services outside Coritan. Open your organization, then Growth, to find them. Only owners and admins see them; a link to one takes any other member to the organization's Overview instead.

Every change on these pages goes on your organization's audit log.

In a Medal quest, a player signs up for Medal with your referral link, records a Minecraft clip, and enters the address players use to join their server. Your customers must sign up for Medal with your referral link, or the boost will not work. When the player finishes, Medal's servers call your organization's endpoint, and the server at that address is boosted until the boost ends. A free server always qualifies. A paid server qualifies only when your organization allows it. A boost is never billed: it changes no plan price and no invoice, and usage billing counts a boosted server at its plan's memory, CPU and disk.

A server can hold up to 10 boosts at once, each with its own end date, and its level is how many it holds. Anyone who knows a server's address can boost it, so a server's players can boost it together. Your organization can have two ladders that say what each level gives:

• Free servers: more memory, CPU and disk, a longer wait before the server sleeps when nobody is playing (up to 240 minutes), MySQL databases, and perks: no "Hosted by" message in the game chat, first place in the start queue on its machine, schedules (they run while the server is online and never start a sleeping server), snapshot download, keeping the world from the inactivity cleanup while boosted, and a Boosted badge on your community server list.
• Paid servers: extras on top of the plan: memory, CPU, disk, ports, MySQL databases, daily automatic backups, and the Boosted badge.

Each level holds the totals at that level, and a number a level leaves out carries forward from the level below. Without a ladder for a plan, each boost adds the same amount of memory and nothing else.

When a boost ends, the level drops. Memory and CPU go back when the server next stops. Disk never drops below what the world already uses, so the server still starts; it gives the rest back once the world fits. The rest of a level ends at once, and databases and ports already made keep working. Moving a server to a paid plan moves its boosts onto the paid ladder, and the free plan moves them back. Two days before a level drops, we email the server's owner how to boost it again, with your referral link.

Coritan sets the quest up for your organization: both ladders, how long a boost lasts, the limits per server and per player, whether paid servers can claim a boost, your referral link, and the key Medal uses. Contact support to start one or to change it. The key starts with mdl_, and Coritan can show it only once, when it is made.

Medal calls this endpoint from its own servers. No member or customer token works on it; only your organization's Medal key does.

curl -X POST "https://api.coritan.com/api/v1/orgs/acme/partners/medal/boosts" \
  -H "Authorization: Bearer $MEDAL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"server_address": "myworld.example.com", "claim_id": "qc_7f2a91"}'

The fields can also arrive as form fields or in the query string. A field in the body wins over the same one in the query string.

A grant answers 201 with status: granted, the boost (memory_mb, the memory this boost adds, granted_at, expires_at), the server and a message written for the player. With a ladder for the server's plan, it also carries level, max_level, ladder (free or paid) and perks, what that level gives. A replayed claim_id answers 200 with replayed: true.

A refusal answers {"detail": {"code": "...", "message": "..."}} and changes nothing, so the player can fix a typo and try again:

The server's limits rise at once. A Java memory setting left at its default follows the new memory when the server restarts; an owner who set it raises it in the server's settings first.

Coritan also sets your referral link: the Medal link your customers sign up with. While the quest is on and has a key, every server of your organization that can take a boost (every free server, and every paid server when your organization allows paid boosts) carries a boosts field in GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}. It holds:

• how many boosts the server has active out of its limit, whether it can take one now (claimable) and when the soonest one ends (expires_at); each active boost's dates are in active_boosts;
• its level out of max_level, the ladder it climbs (free or paid), the ladder's levels (or null without one), what the level gives now (perks) and what the next boost would give (next);
• referral_url, where every boost button should send people: your referral link, else your signup link, else Medal's site. Tell your customers to sign up for Medal with it, or the boost will not work;
• address, what to enter in the quest, and paid, which is true on a paid server, so your storefront can word the levels as extras on top of the plan.

The server's own cpu_percent and disk_mb include what its level adds, as memory_mb does, with the plan's figures in base_cpu_percent and base_disk_mb. Each item in its entitlements carries boost_unlocks_at: the level that unlocks what the free plan withholds, or null. A paid server carries boosts: null unless your organization allows paid boosts.

To decide whether your storefront should mention the quest to a signed-in customer right now, call GET /api/v1/orgs/{org_slug}/portal/partners/medal/offer with the customer's token as Authorization: Bearer $CUSTOMER_TOKEN. It reads the quest and the customer's own servers, writes nothing, and answers for that customer only, so do not cache it.

curl "https://api.coritan.com/api/v1/orgs/acme/portal/partners/medal/offer" \
  -H "Authorization: Bearer $CUSTOMER_TOKEN"

The answer holds show, state, server, offer and account_age_ok. show is true only when there is something to do. state says what:

server is the one to point at, or null: a free server that can take a boost first, otherwise a paid one. It holds id, uuid, name, address (what players join with, and what to enter in the quest), plan (free or paid), boost_memory_mb (the memory the next boost adds), level, max_level and next. offer holds the boost on offer (memory_mb, duration_days), paid_servers (whether paid servers can claim), referral_url, quest_url, signup_url, partner_url, max_level and your ladders (levels, paid_levels), or null when the quest is off. account_age_ok is true once the account is 24 hours old. Only servers the customer owns count, not servers shared with them. A support session acting as the customer always gets show: false.

• Connect a Discord server
• Customise the game proxy messages
• Roles and permissions