Getting Started

Recommended Posts

Setup of IPBWI v4 API is quite easy. Just follow the steps described below to start coding your own apps powered by IPBWI v4 API.

Choose a version

IPBWI v4 API is provided in two versions: PHP 5 and PHP 7. While PHP 5 version runs on PHP 7, too, the PHP 7 version brings additional improvements for safety. Please note, that PHP 5 support for IPBWI v4 API has been dropped since 2017, so newest features will be available for PHP 7 version only. To make it clear: using the PHP 5 version is not recommended nor supported anymore - please switch to PHP 7. All documentations are based on PHP 7 version.


  1. download the IPBWI v4 API ZIP archive
  2. unzip ZIP package into any local folder. You'll see three folders:
    1. ipbwi-api-previews
        • contains screenshots of REST API documentation
      • ipbwi-api-application
        • contains the IPS application to enhance the IPS REST API
        • Go to IPS ACP -> System -> Site Features -> Applications -> Install and upload file /ipbwi-api-application/ipbwi.tar
        • Go To IPS ACP -> System -> Site Features -> REST API -> Create New
          • Give it a Reference Name and enable all endpoints you'll plan to use. You will need the API Key generated here later for IPBWI's config settings.
          • Full API reference is available as tab on the REST API site.
      • ipbwi-api
        • contains the PHP wrapper for REST API calls plus testing code snippets
        • upload the ipbwi-api folder via ftp to your webhost
        • rename config.php.dist to config.php
        • Fill the settings for config.php:
          • ipbwi_IPS_CONNECT_BASE_URL
            • This is the base URL of your forum.
          • ipbwi_IPS_CONNECT_MASTER_KEY
            • Master KEY as shown in IPS ACP -> System -> Settings -> Login Handlers
          • ipbwi_IPS_CONNECT_SLAVE_URL
            • Define a slave URL. This URL will be used to propagate SSO changes from IPS master to your slave.
          • ipbwi_IPS_CONNECT_SLAVE_KEY
            • That should be a unique key. md5 string of your slave URL would suit in most scenarios.
          • REST API KEY
            • Insert the API Keys created with installing the ipbwi-api-application.
        • The /testing/ folder contains some example requests.

    Start coding

    You are prepared now for developing your own PHP apps powered by IPBWI API. Just include the ipbwi.php into your project and start coding.

    Share this post

    Link to post
    Share on other sites