README

BIMData API is a tool to interact with your models stored on BIMData’s servers. Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints.

Installation & Usage

Requirements

PHP 7.4 or PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BcfApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$projects_pk = 'projects_pk_example'; // string
$topics_guid = 'topics_guid_example'; // string
$data = new \OpenAPI\Client\Model\Comment(); // \OpenAPI\Client\Model\Comment

try {
    $result = $apiInstance->createComment($projects_pk, $topics_guid, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BcfApi->createComment: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.bimdata.io

Models

• BcfProject
• CheckPlan
• CheckerResult
• Classification
• ClippingPlane
• Cloud
• CloudInvitation
• CloudRole
• Coloring
• Comment
• Component
• ComponentsParent
• Direction
• Document
• Element
• Extensions
• Feature
• Folder
• FolderGroupPermission
• FosUserId
• FullTopic
• GroupFolder
• GroupFolderFolder
• GroupFolderGroup
• Ifc
• IfcAccessToken
• IfcChecker
• IfcCheckerCheckplan
• IfcCheckerResults
• IfcErrors
• IfcExport
• IfcFiles
• IfcMerge
• IfcOptimize
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineObject4
• InlineObject5
• InlineResponse200
• InlineResponse2001
• Invitation
• Label
• Layer
• LayerElement
• Line
• MarketplaceApp
• MarketplaceAppImage
• Material
• MaterialListComponent
• MaterialOption
• Organization
• OrthogonalCamera
• PerspectiveCamera
• Point
• Priority
• ProcessorHandler
• Project
• ProjectAccessToken
• ProjectInvitation
• ProjectRole
• ProjectWithChildren
• Property
• PropertyDefinition
• PropertySet
• RawClassification
• RawDefinition
• RawElement
• RawElements
• RawLayer
• RawMaterial
• RawMaterialList
• RawMaterialListComponents
• RawMaterialOptions
• RawProperty
• RawPropertySet
• RawSystem
• RawUnit
• RecursiveFolderChildren
• Rule
• RuleComponent
• Ruleset
• SelectUser
• SelfBcfUser
• SelfUser
• SimpleElement
• Snapshot
• Space
• Stage
• System
• Topic
• TopicStatus
• TopicType
• Unit
• User
• UserCloudUpdate
• UserProjectUpdate
• ViewSetupHints
• Viewpoint
• Visibility
• WebHook
• Zone
• ZoneSpace

Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

bimdata_connect

• Type: OAuth
• Flow: implicit
• Authorization URL: https://iam.bimdata.io/auth/realms/bimdata/protocol/openid-connect/auth
• Scopes: N/A

client_credentials

• Type: OAuth
• Flow: application
• Authorization URL: https://iam.bimdata.io/auth/realms/bimdata/protocol/openid-connect/token
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@bimdata.io

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Build package: org.openapitools.codegen.languages.PhpClientCodegen