pdir/propstack-api

Simple API Integration for Propstack

0.1.0 2022-01-06 06:52 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^6.3
• guzzlehttp/oauth-subscriber: 0.4.*
• psr/cache: ^1.0

Requires (Dev)

• fzaninotto/faker: ^1.9.1
• phpunit/phpunit: ^8.5
• symfony/cache: ^5.1

MIT

• rest
• api
• propstack

README

Requirements

PHP: >= 7.2
Extensions: Composer, PHP-JSON

Install

composer:
composer require pdir/propstack-api

Usage

Search for the official API Documentation here.
You need an Api Key - Ask support or visit account settings in Propstack.

Basic

// store keys in .env file or use credentials array
$credentials = [
    'apiKey' => 'PROPSTACK_API_KEY', 
];

$api = new Pdir\Propstack\Api();
or
$api = new Pdir\Propstack\Api($credentials);

// get all projects
$projects = $api->getProjects();

// get all saved queries
$savedQueries = $api->getSavedQueries();