GeometryBackendSdkPhp

ShapeDiver is a cloud platform for building online applications based on parametric 3D files made with Rhinoceros 3D and Grasshopper.

Using the ShapeDiver Geometry Backend API allows access to ShapeDiver models without using the ShapeDiver Viewer. This SDK provides functionality to communicate with the Geometry Backend API version 2, and includes type hints describing request and response data objects. See the API documentation for more details.

Getting Started

Composer

To install a respective version of the bindings (in the example below the version is 1.0.0) via Composer, add the following to your composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/shapediver/GeometryBackendSdkPhp.git"
    }
  ],
  "require": {
    "shapediver/geometry-api-v2": "dev-main#v1.0.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Authentication

The authentication system for the Geometry Backend API is based on ticket objects and JWT tokens, which are handled by the ShapeDiver Platform. You can obtain tickets and JWT tokens by:

• using your account on the ShapeDiver Platform (tickets only), or

• you can obtain them programmatically using the ShapeDiver Platform API (both tickets and JWT tokens).

An SDK for the ShapeDiver Platform API will be released soon.

When obtaining a ticket for your model from the ShapeDiver Platform, please be aware that you will need a ticket for backend access, since you are accessing the Geometry Backend API from an arbitrary client application that is not a web browser. For more details see the ShapeDiver Help Center developer settings.

Base URL

The base URL to use depends on which ShapeDiver Geometry Backend System your model was uploaded to. You can find the base URL in your model's dashboard on the ShapeDiver Platform, it is also called the model view url.

Usage - Ticket only

use ShapeDiver\GeometryApiV2\SdClient;
use ShapeDiver\GeometryApiV2\SdConfig;
use ShapeDiver\GeometryApiV2\Client\Api\SessionApi;

function initSession(): void
{
    // Please see above on how to obtain a ticket
    $ticket = "8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386";

    // Initialize the SDK client instance by providing the base URL
    $client = new SdClient();
    $config = (new SdConfig())->setHost("https://sdeuc1.eu-central-1.shapediver.com");

    // Initialize a new session using the ticket.
    $res = (new SessionApi($client, $config))->createSessionByTicket($ticket);

    print_r($res);
}

Usage - Ticket and JWT

It is possible to configure your ShapeDiver models such that JWT tokens are required to communicate with them, which provides a strong authorisation mechanism. In this case you will need to use the ShapeDiver Platform API to obtain a JWT token for your model on demand:

use ShapeDiver\GeometryApiV2\SdClient;
use ShapeDiver\GeometryApiV2\SdConfig;
use ShapeDiver\GeometryApiV2\Client\Api\SessionApi;

function initSession(): void
{
    // Please see above on how to obtain a ticket and a JWT.
    $jwt = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikp1c3QgYSB0ZXN0IiwiaWF0IjoxNjE4OTExMjcxLCJleHAiOjE2MTg5MTQ4OTcsImp0aSI6IjYzMjA3ODE3LWJiNWQtNDY3Zi04NzRkLWM4N2EyYzAxYmZlZCJ9.S5Ps_Fx5p6aJxdBOJMBKgpf2SIlp--6kkIZU55tiqEg";
    $ticket = "8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386";

    // Initialize the SDK client instance by providing the base URL
    $client = new SdClient();
    $config = (new SdConfig())
        ->setHost("https://sdeuc1.eu-central-1.shapediver.com")
        ->setAccessToken($jwt);

    // Initialize a new session using the ticket.
    $res = (new SessionApi($client, $config))->createSessionByTicket($ticket);

    print_r($res);
}

Examples

Examples on how to interact with available endpoints are given in the tests folder.

Making Changes & Contributing

Most of the code in this repository has been generated via the OpenAPI Generator. The specification of the Geometry Backend API version 2 can be found in the ShapeDiver OAS repository. Additionally, we have added wrappers and utility functions to improve overall usability.

Setup

This project is written in PHP 8.0 and uses Composer as a dependency manager. Project-specific commands are handled via just, so install this tool as well. To get an overview of all available commands, run just --list.

Run the following commands to install all dependencies:

just setup

Generate Code

To re-generate the code from the ShapeDiver OAS file, you need to install version 7 of the OpenAPI Generator. We recommend installing it as a global NPM package:

npm i -g openapi-generator

Afterwards, update the local file ./oas_spec.yaml and generate the new code via just generate <version>. The version argument represents the respective Git tag from ShapeDiver OAS. For instance, use version "1.0.0" when targeting the Git tag "[email protected]".

Alternatively, the client can be generated from a local file. Check out the ShapeDiver OAS repository and run just generate local.

Release

Currently, this SDK package is not uploaded to any public registry.

Test

Unit and integration tests can be executed via just test. However, should you want to run only a single test file then use ./vendor/bin/phpunit <path> instead.

Versioning

We take care to provide backwards compatibility for all older versions. However, new features might be limited to newer API versions. Therefore, we recommend always using the newest API version out there.

Support

If you have questions, please use the ShapeDiver Help Center.

You can find out more about ShapeDiver right here.

Licensing

This project is released under the MIT License.