PHPackages                             floorplanner/roomstyler-api-php - 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. [API Development](/categories/api)
4. /
5. floorplanner/roomstyler-api-php

ActiveLibrary[API Development](/categories/api)

floorplanner/roomstyler-api-php
===============================

A PHP wrapper for the Roomstyler API.

v0.1.4(9y ago)121MITPHPPHP >=5.0.0

Since Jun 27Pushed 9y ago4 watchersCompare

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

READMEChangelogDependenciesVersions (9)Used By (0)

Roomstyler PHP API
==================

[](#roomstyler-php-api)

---

This is a PHP library that makes it easier to use the [Roomstyler RESTful API](http://floorplanner.io/docs/roomstyler-api). It is intended to be a wrapper for the API so that you, as user of the API will never have to write your own HTTP requests but instead can simply call a method to do it for you.

 Table of contents
---------------------------------------------------------

[](#-table-of-contents)

- [Table of contents](#heading_toc)
- [Installation](#heading_install)
    - [Manual (using GUI)](#heading_install_manual)
    - [Manual (using git + command line)](#heading_install_manual_git_cli)
    - [Composer](#heading_install_composer)
- [Getting started](#heading_getting_started)
    - [Anonymous API access](#api_access_anon)
    - [User API access](#api_access_user)
    - [Whitelabel API access](#api_access_wl)
    - [Full API access](#api_access_god)
    - [Settings](#heading_config_options)
- [Structure](#heading_structure)
    - [RoomstylerApi](#structure_object_roomstyler_api)
    - [RoomstylerMethodBase](#structure_object_roomstyler_method_base)
    - [RoomstylerModelBase](#structure_object_roomstyler_model_base)
- [Errors](#errors)
    - [RoomstylerError](#roomstyler_error)
        - [`any()`](#roomstyler_error_any)
        - [`get()`](#roomstyler_error_get)
        - [`each()`](#roomstyler_error_each)
- [API endpoints](#api_endpoints)
    - [Rooms](#heading_rooms)
        - [List](#fetch_rooms)
        - [List whitelabel](#fetch_whitelabel_rooms)
        - [Find](#find_specific_room)
        - [Search](#searching_rooms)
        - [Panorama's](#fetch_panoramas)
        - [Panorama](#fetch_panorama)
        - [Comment](#comment_on_room)
        - [Toggle love](#love_a_room)
        - [Change owner](#change_room_owner)
        - [Delete](#delete_room)
        - [Products](#fetch_room_products)
        - [Loves](#fetch_room_loves)
        - [Related rooms](#fetch_related_rooms)
        - [Comments](#fetch_room_comments)
        - [Add tags](#add_room_tags)
        - [Remove tags](#remove_room_tags)
        - [Render](#render_room)
    - [Users](#heading_users)
        - [Find](#finding_users)
        - [Create](#create_a_user)
        - [Login](#user_login)
        - [Delete](#delete_a_user)
        - [Loved rooms](#user_loved_rooms)
        - [Collections](#user_collections)
        - [Specific user collections](#user_specific_collection)
    - [Contests](#heading_contests)
        - [List](#fetch_contests)
        - [Find](#fetch_specific_contest)
        - [Entries](#fetch_contest_entries)
    - [Contest Entries](#heading_contest_entries)
        - [Vote](#vote_for_contest_entry)
    - [Materials](#heading_materials)
        - [Find](#find_material)
    - [Components](#heading_components)
        - [Find](#find_component)
    - [Categories](#heading_categories)
        - [List](#fetch_categories)
- [3dplanner](#3dplanner)
    - [Embed](#embed_3dplanner)

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

[](#-installation)

Based on [the roomstyler RESTful API](http://floorplanner.io/docs/roomstyler-api), should anything be/remain unclear after reading the docs, check the documentation on there as well to see if it is more clear. Also, this is not a 1-on-1 copy of the API, some method calls are grouped (`render` for instance can do `panorama`, `hq` and `2d` aside from the default `3d`) or have a slightly more convenient way of adding parameters.

###  Manual (using GUI)

[](#-manual-using-gui)

1. Go to [github.com/floorplanner/roomstyler-api-php](https://github.com/floorplanner/roomstyler-api-php)
2. Click on the `Clone or download` button
3. Select `Download ZIP`
4. Extract the `.zip` and move or copy it to the root of the project
5. Require `roomstyler-api-php-master/api/RoomstylerApi.php` in your application

###  Manual (using git and command line)

[](#-manual-using-git-and-command-line)

```
~ $ cd project-root
project-root $ git clone git@github.com:floorplanner/roomstyler-api-php.git

```

This command clones the repository to `project-root/roomstyler-api-php/`, to require it add:

```

```

###  Composer (using command line)

[](#-composer-using-command-line)

```
~ $ cd composer-project-root
composer-project-root $ composer require floorplanner/roomstyler-api-php

```

 Getting Started
-------------------------------------------------------------------

[](#-getting-started)

###  Anonymous API access

[](#-anonymous-api-access)

When you want to read public data

```

```

###  User API access

[](#-user-api-access)

For personal use, read global data or perform actions on rooms as the signed in user (whitelabel users can also login)

```