navarr/minecraft-api

An API for validating a Minecraft user against Mojang's servers

Maintainers

Details

github.com/navarr/MinecraftAPI

Source

Issues

Fund package maintenance!
navarr

Installs: 398

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 1

2.0 2014-04-10 02:11 UTC

Requires

  • php: >=5.3.0
  • ext-curl: *

MIT a51b352f9dac40ee7f3b7aaef2d7bdd228d110e0

This package is auto-updated.

Last update: 2024-12-12 04:07:39 UTC

README

An API for validating a user against Mojang's servers written in PHP

Installation

Assuming you have composer,

php composer.phar require navarr/minecraft-api:2.*

How to use

Using the MinecraftAPI is incredibly easy in PHP. Assuming that you have it installed via composer,

<?php
    // composer autoload call
    
    use Navarr\MinecraftAPI\MinecraftAPI;
    use Navarr\MinecraftAPI\Exception\BadLoginException;
    use Navarr\MinecraftAPI\Exception\MigrationException;
    use Navarr\MinecraftAPI\Exception\BasicException;
    
    try {
        $minecraftApi = new MinecraftAPI($username, $password);
    } catch (BadLoginException $e) {
        // Invalid Credentials
    } catch (MigrationException $e) {
        // User tried to login with their minecraft name instead of their mojang account handle (and have migrated)
    } catch (BasicException $e) {
        // The account is a "basic" Minecraft account.  They have not purchased Minecraft.
    }
    
    $minecraftName = $minecraftApi->username;
    $accessToken = $minecraftApi->accessToken;
    $uuid = $minecraftApi->minecraftID;

License

MIT License (coming soon!)