Category: guides

Endpoint: https://link.platformsync.io/api.php?id=<STEAM/DISCORD ID>&token=<TOKEN>

Your token is the same token you use in the Platform Sync Plugin

Rate Limit: 100 requests per minute (Token based)

Response types

Normal Response

{
  "linked": true,
  "steam_id": "123456",
  "discord_id": "123456",
  "previous_discord_ids": "987654"
}

Error Responses

Rate Limit Exceeded (429)

Access Denied (401)

Invalid Subscription (401)

Example

{"Error":"Access Denied"}

Please note that the Platform Sync API is only avaliable for Platform Sync Pro customers.

Thank you for choosing Platform Sync! Please follow the below instructions to set up your service:

1. Go to https://www.platformsync.io/my-account/edit-account/ and scroll down until you see “Platform Sync Bot Details”.
2. Fill in all the necessary fields. If you do not know how to get Discord IDs, you can follow this guide to enable on your client. Please refer to the table below for an explanation of what each one is.
3. Invite the bot to your discord server using the invite link in the main menu.
4. Once the bot is in your server, confirm that the permissions are correct. The bot should have:
   1. Manage Roles
   2. Send Messages
   3. Manage Messages
   4. The bot also needs to be higher in the roles list than both your Verified role and your Nitro role. Failure to do this will mean it will not be able give users those roles.
5. In a chat channel, the bot has access to type /auth. This will generate your API key, which will be DM’ed to you.
6. If you already have Nitro Boosters in your discord, enter the command /loadnitro to sync your current nitro users with Platform Sync.
7. You will need to set up a discord chat channel that non-verified users can see. This is where you will show your users how to link their Discord accounts with their Steam accounts. Once you have set this channel up, use the /instructions command in this channel to display the embed.
8. Install the Platform Sync oxide plugin on your server and fill in the predefined fields in the config file. The plugin can be downloaded from https://www.platformsync.io/my-account/downloads/

That’s it, and you’re done! If at any point you get stuck, please don’t hesitate to reach out to our support team on discord at https://discord.gg/7PtDYGrU74 

Platform Sync configuration fields

A common mistake that is made when it comes to getting discord IDs is confusing them with a users username and discriminator e.g. DiscordUser#001. Their discord ID is entirely different and is a series of numbers. Almost every aspect of Discord has a unique ID attached to it, the following are some common ones:

• Guild’s (Discord Servers)
• Users
• Channels
• Roles
• Messages

To get an entities Discord ID you need to turn on Discord Developer mode.

Enabling Discord Developer Mode

Open Discord and in the bottom left you will see a COG (next to where you mute and deafen). Click it

Click Advanced

Slide the slider next to Developer Mode to the right until it turns from a grey cross to a green tick.

You will now be able to right-click on elements within discord and you will now be able to see the menu item Copy ID. This will copy the ID to your clipboard which you can paste using the keyboard shortcut ctrl+v (windows) or command+v (mac)

How to get IDs for different elements

Guilds

• Join the guild (discord server) you want the ID for.
• In the left hand bar right click on the guild and select Copy ID.

Users

• Find the user you want to get the ID for in the discord server user list. You can also do this from your direct messages and firends list.
• Right click on the user and select Copy ID.

Channels

• Find the channel you want to get the ID for in the Guild.
• Right click and select Copy ID.

Roles

Option 1 (server admins)

• Open the Server Settings menu.
• Select Roles.
• Right click on the intended role.
• Select Copy ID

Option 2 (non-admins)

• Find a user in the guilds user list with the intended role.
• Right click on the role.
• Select Copy ID

Messages

• Right click on the intended message.
• Click Copy ID.