pixels/torn-api

A PHP wrapper around the Torn API

1.1.2 2020-11-16 18:12 UTC

Requires

• php: >=7.0
• guzzlehttp/guzzle: ^6.5

Requires (Dev)

• phpunit/phpunit: 8

MIT

• Pixels

• torn

README

Installation

The preferred method of installation is via Composer.

composer require pixels/torn-api

Usage

There are services for all API endpoints. They all follow the same pattern as the example below.

$masterApiKey = 'masterApiKey'; // Used as a fallback if no key is specified in a request
$selections = [\Torn\Services\UserService::BASIC];
$userId = 'someUserId';
$userApiKey = 'yourApiKey';
$useTornProxyByDefault = false;
$forceTornProxy = true; // Allows you to use Torn Proxy for a specific request
$httpClient = new GuzzleHttp\Client();

$client = new Torn\Client($httpClient, $masterApiKey, $useTornProxyByDefault);
$userService = new Torn\Services\UserService($client);
$user = $userService->fetch($userId, $selections, $userApiKey, $forceTornProxy);