https://github.com/pdir/propstack-api

Simple Propstack PHP API
https://github.com/pdir/propstack-api

Last synced: 14 days ago
JSON representation

Simple Propstack PHP API

• Host: GitHub
• URL: https://github.com/pdir/propstack-api
• Owner: pdir
• License: mit
• Created: 2022-01-05T17:30:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-06T06:52:43.000Z (almost 3 years ago)
• Last Synced: 2024-11-27T20:14:40.587Z (26 days ago)
• Language: PHP
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Propstack PHP API

## Requirements

PHP: >= 7.2  

Extensions: [Composer](https://getcomposer.org/), [PHP-JSON](https://www.php.net/manual/en/book.json.php)

## Install

composer:  

`composer require pdir/propstack-api`

## Usage

Search for the official API Documentation [here](https://docs.propstack.de/).  

You need an *Api Key* - Ask support or visit account settings in Propstack.

### Basic

```php

// 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();

```