Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 994 Bytes

README.md

File metadata and controls

32 lines (19 loc) · 994 Bytes
Raw

mcverify

A simple REST API for linking your users' Minecraft: Java Edition accounts. Powered by Phpcraft.

Try it!

Using the REST API

You may use https://api.mcverify.de/ but you can obviously also set up your own instance.

All endpoints respond using JSON (application/json).

Starting a Challenge

GET /start?service=...

Starts a challenge for your user to fulfil. The service parameter is used in the kick message, e.g. "Thanks! You may now return to service."

{
	"address": "abcd.mcverify.de" // The address the user is to connect to.
}

Getting a Challenge's status

GET /status/<address>

Returns an empty object ({}) or, if a user had connected to the address, information about that user:

{
	"username": "timmyRS",                         // The in-game name of the Minecraft account.
	"uuid": "e0603b59-2edc-45f7-acc7-b0cccd6656e1" // The unique user ID of the Mojang account.
}