PHPackages                             getfokus/positionly - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. getfokus/positionly

ActiveLibrary[Utility & Helpers](/categories/utility)

getfokus/positionly
===================

PHP library for positionly.com

2249.6k↓54.5%2PHP

Since Dec 30Pushed 12y ago2 watchersCompare

[ Source](https://github.com/getfokus/positionly-api)[ Packagist](https://packagist.org/packages/getfokus/positionly)[ RSS](/packages/getfokus-positionly/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

PHP library for Positionly
==========================

[](#php-library-for-positionly)

Full API documentation:

**Table of Contents**

- [PHP library for Positionly](#php-library-for-positionly)
    - [Author & Contact](#author-&-contact)
    - [Installation](#installation)
        - [Composer](#composer)
    - [Usage instructions](#usage-instructions)
        - [`GET` request](#get-request)
        - [`DELETE` request](#delete-request)
        - [`POST` request](#post-request)
        - [Full example](#full-example)

\###Author & Contact
------------------------

[](#author--contact)

Piotr *Athlan* Pelczar -

Installation
------------

[](#installation)

\###Composer
------------

[](#composer)

Add dependency in `composer.json`:

```
"require": {
    "getfokus/positionly": "*"
},

```

Usage instructions
------------------

[](#usage-instructions)

1. Set credentials (clientId, clientSecret, username and password) for OAuth2 authentication and create OAuth2\\Client object.
2. Obtain the OAuth2 Access Token (password method)
3. Pass client object into PositionlyApi instance.
4. Call the api:

```
$response = $api->get('/accounts'); // for https://api.positionly.com/v1/accounts.json

// the $response contains the array with result
```

### `GET` request

[](#get-request)

---

To make `GET` request just use:

```
$response = $api->get('/accounts');
$response = $api->get('/accounts//websites');

if($response->isSuccess()) {
	echo 'Success:';

	$result = $response->getResult();
	print_r($result);
}
else {
	echo 'Failure.';
}
```

### `DELETE` request

[](#delete-request)

To make `DELETE` request just use:

```
$response = $api->delete('/accounts//websites/');

if($response->isSuccess()) {
	echo 'Success:';
}
else {
	echo 'Failure.';
}
```

### `POST` request

[](#post-request)

---

To make `POST` request just use:

```
$params = array(
	'scheme' => 'http',
	'name' => 'example.com',
	'title' => 'Example website',

	'website_engines_attributes' => array(
	    array(
			"engine_id" => 43,
		)
	)
);

$response = $api->post('/accounts//websites', $params);

if($response->isSuccess()) {
	echo 'Success:';

	$result = $response->getResult();
	print_r($result);
}
else {
	echo 'There are errors in form:';

	$result = $response->getResult();
	print_r($result['errors']);
}
```

### Full example

[](#full-example)

---

```