/node-plex-api-pinauth

PIN authentication for plex-api

Primary LanguageJavaScriptMIT LicenseMIT

node-plex-api-pinauth

An authentication module for node-plex-api that handles the API requests necessary for getting an auth token using a PIN.

Usage

The following code retrieves a PIN and waits for the user to enter the PIN on plex.tv so a token can be retrieved. A PIN is valid for 15 minutes and after that this script will timeout.

const PlexPin = require('./index');

/*
 * CONFIG
 */
const plexOptions = {
	identifier: '123-ABC-456-DEF-789',
	product: 'Your Product',
	version: '1.0',
	deviceName: 'Device Name',
	platform: 'Platform Name'
};

const plexPin = new PlexPin(plexOptions);


/*
 * Get a PIN
 */
plexPin.getPin().then(pin =>
{
	// print pin
	console.log(pin.code);
	
	// get token
	let ping = setTimeout(function pollToken()
	{
		plexPin.getToken(pin.id)
			.then(res =>
			{
				// success getting token
				if (res.token === true)
				{
					console.log(res['auth-token']);
					return;
				}
				
				// failed getting token
				else if (res.token === false)
				{
					console.error('Timeout!');
					return;
				}
				
				// polling
				else
					ping = setTimeout(pollToken, 1000);
			})
			.catch(err => console.error(JSON.stringify(err)));
		
	}, 2000);
})
.catch(err => console.error(err.message));

If you only wish to verify a PIN, use the following script:

plexPin.getToken(6566262696).then(res => // fake PIN
{
	// success getting token
	if (res.token === true)
		console.log(res['auth-token']);
	
	// failed getting token
	else if (res.token === false)
		console.error('Timeout!');
	
	// polling
	else
		console.error('No token found!');
})
.catch(err => console.error(err.message));

License

The MIT License (MIT)

Copyright (c) 2019 Zefau zefau@mailbox.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.