Download the PHP package bcartfall/forge-client without Composer

On this page you can find all versions of the php package bcartfall/forge-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package forge-client

Forge PHP SDK

Forge API: oAuth2 Data-Management OSS Model-Derivative

Overview

This PHP SDK enables you to easily integrate the Forge REST APIs into your application, including OAuth, Data Management, Model Derivative, and Design Automation.

Requirements

Installation

Composer

To install the bindings via Composer, run:

Manual Installation

Download the files and include autoload.php:

Tutorial

Follow this tutorial to see a step-by-step authentication guide, and examples of how to use the Forge APIs.

Create an App

Create an app on the Forge Developer portal. Note the client ID and client secret.

Authentication

This SDK comes with an OAuth 2.0 client that allows you to retrieve 2-legged and 3-legged tokens. It also enables you to refresh 3-legged tokens. The tutorial uses 2-legged and 3-legged tokens for calling different Data Management endpoints.

2-Legged Token

This type of token is given directly to the application.

To get a 2-legged token run the following code. Note that you need to replace your-client-id and your-client-secret with your app's client ID and client secret.

3-Legged Token

Generate an Authentication URL

To ask for permissions from a user to retrieve an access token, you redirect the user to a consent page.

Replace your-client-id, your-client-secret, and your-redirect-url with your app's client ID, client secret, and redirect URL, and run the code to create a consent page URL.

Note that the redirect URL must match the callback URL you provided when you created the app.

Retrieve an Authorization Code

Once a user receives permissions on the consent page, Forge will redirect the page to the redirect URL you provided when you created the app. An authorization code is returned in the query string.

GET /callback?code={authorizationCode}

Retrieve an Access Token

Request an access token using the authorization code you received, as shown below:

Note that access tokens expire after a short period of time. The expires_in field gives the validity of an access token in seconds. To refresh your access token, call the $threeLeggedAuth->refreshToken($refreshToken); method.

Example API Calls

Use the TwoLeggedAuth object or the ThreeLeggedAuth object to call the Forge APIs.

API Documentation

You can get the full documentation for the API on the Developer Portal

Documentation for API Endpoints

All URIs are relative to https://developer.api.autodesk.com. For example, the createActivity URI is 'https://developer.api.autodesk.com/autocad.io/us-east/v2/Activities'.

Class Method HTTP request Description
ActivitiesApi createActivity POST /autocad.io/us-east/v2/Activities Creates a new Activity.
ActivitiesApi deleteActivity DELETE /autocad.io/us-east/v2/Activities('{id}') Removes a specific Activity.
ActivitiesApi deleteActivityHistory POST /autocad.io/us-east/v2/Activities('{id}')/Operations.DeleteHistory Removes the version history of the specified Activity.
ActivitiesApi getActivity GET /autocad.io/us-east/v2/Activities('{id}') Returns the details of a specific Activity.
ActivitiesApi getActivityVersions GET /autocad.io/us-east/v2/Activities('{id}')/Operations.GetVersions Returns all old versions of a specified Activity.
ActivitiesApi getAllActivities GET /autocad.io/us-east/v2/Activities Returns the details of all Activities.
ActivitiesApi patchActivity PATCH /autocad.io/us-east/v2/Activities('{id}') Updates an Activity by specifying only the changed attributes.
ActivitiesApi setActivityVersion POST /autocad.io/us-east/v2/Activities('{id}')/Operations.SetVersion Sets the Activity to the specified version.
AppPackagesApi createAppPackage POST /autocad.io/us-east/v2/AppPackages Creates an AppPackage module.
AppPackagesApi deleteAppPackage DELETE /autocad.io/us-east/v2/AppPackages('{id}') Removes a specific AppPackage.
AppPackagesApi deleteAppPackageHistory POST /autocad.io/us-east/v2/AppPackages('{id}')/Operations.DeleteHistory Removes the version history of the specified AppPackage.
AppPackagesApi getAllAppPackages GET /autocad.io/us-east/v2/AppPackages Returns the details of all AppPackages.
AppPackagesApi getAppPackage GET /autocad.io/us-east/v2/AppPackages('{id}') Returns the details of a specific AppPackage.
AppPackagesApi getAppPackageVersions GET /autocad.io/us-east/v2/AppPackages('{id}')/Operations.GetVersions Returns all old versions of a specified AppPackage.
AppPackagesApi getUploadUrl GET /autocad.io/us-east/v2/AppPackages/Operations.GetUploadUrl Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage.
AppPackagesApi getUploadUrlWithRequireContentType GET /autocad.io/us-east/v2/AppPackages/Operations.GetUploadUrl(RequireContentType={require}) Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage. Unlike the GetUploadUrl method that takes no parameters, this method allows the client to request that the pre-signed URL to be issued so that the subsequent HTTP PUT operation will require Content-Type=binary/octet-stream.
AppPackagesApi patchAppPackage PATCH /autocad.io/us-east/v2/AppPackages('{id}') Updates an AppPackage by specifying only the changed attributes.
AppPackagesApi setAppPackageVersion POST /autocad.io/us-east/v2/AppPackages('{id}')/Operations.SetVersion Sets the AppPackage to the specified version.
AppPackagesApi updateAppPackage PUT /autocad.io/us-east/v2/AppPackages('{id}') Updates an AppPackage by redefining the entire Activity object.
BucketsApi createBucket POST /oss/v2/buckets
BucketsApi deleteBucket DELETE /oss/v2/buckets/{bucketKey}
BucketsApi getBucketDetails GET /oss/v2/buckets/{bucketKey}/details
BucketsApi getBuckets GET /oss/v2/buckets
DerivativesApi deleteManifest DELETE /modelderivative/v2/designdata/{urn}/manifest
DerivativesApi getDerivativeManifest GET /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}
DerivativesApi getFormats GET /modelderivative/v2/designdata/formats
DerivativesApi getManifest GET /modelderivative/v2/designdata/{urn}/manifest
DerivativesApi getMetadata GET /modelderivative/v2/designdata/{urn}/metadata
DerivativesApi getModelviewMetadata GET /modelderivative/v2/designdata/{urn}/metadata/{guid}
DerivativesApi getModelviewProperties GET /modelderivative/v2/designdata/{urn}/metadata/{guid}/properties
DerivativesApi getThumbnail GET /modelderivative/v2/designdata/{urn}/thumbnail
DerivativesApi translate POST /modelderivative/v2/designdata/job
EnginesApi getAllEngines GET /autocad.io/us-east/v2/Engines Returns the details of all available AutoCAD core engines.
EnginesApi getEngine GET /autocad.io/us-east/v2/Engines('{id}') Returns the details of a specific AutoCAD core engine.
FoldersApi getFolder GET /data/v1/projects/{project_id}/folders/{folder_id}
FoldersApi getFolderContents GET /data/v1/projects/{project_id}/folders/{folder_id}/contents
FoldersApi getFolderParent GET /data/v1/projects/{project_id}/folders/{folder_id}/parent
FoldersApi getFolderRefs GET /data/v1/projects/{project_id}/folders/{folder_id}/refs
FoldersApi getFolderRelationshipsRefs GET /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs
FoldersApi postFolder POST /data/v1/projects/{project_id}/folders
FoldersApi postFolderRelationshipsRef POST /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs
HubsApi getHub GET /project/v1/hubs/{hub_id}
HubsApi getHubs GET /project/v1/hubs
ItemsApi getItem GET /data/v1/projects/{project_id}/items/{item_id}
ItemsApi getItemParentFolder GET /data/v1/projects/{project_id}/items/{item_id}/parent
ItemsApi getItemRefs GET /data/v1/projects/{project_id}/items/{item_id}/refs
ItemsApi getItemRelationshipsRefs GET /data/v1/projects/{project_id}/items/{item_id}/relationships/refs
ItemsApi getItemTip GET /data/v1/projects/{project_id}/items/{item_id}/tip
ItemsApi getItemVersions GET /data/v1/projects/{project_id}/items/{item_id}/versions
ItemsApi postItem POST /data/v1/projects/{project_id}/items
ItemsApi postItemRelationshipsRef POST /data/v1/projects/{project_id}/items/{item_id}/relationships/refs
ObjectsApi copyTo PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/copyto/{newObjName}
ObjectsApi createSignedResource POST /oss/v2/buckets/{bucketKey}/objects/{objectName}/signed
ObjectsApi deleteObject DELETE /oss/v2/buckets/{bucketKey}/objects/{objectName}
ObjectsApi deleteSignedResource DELETE /oss/v2/signedresources/{id}
ObjectsApi getObject GET /oss/v2/buckets/{bucketKey}/objects/{objectName}
ObjectsApi getObjectDetails GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/details
ObjectsApi getObjects GET /oss/v2/buckets/{bucketKey}/objects
ObjectsApi getSignedResource GET /oss/v2/signedresources/{id}
ObjectsApi getStatusBySessionId GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId}
ObjectsApi uploadChunk PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable
ObjectsApi uploadObject PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}
ObjectsApi uploadSignedResource PUT /oss/v2/signedresources/{id}
ObjectsApi uploadSignedResourcesChunk PUT /oss/v2/signedresources/{id}/resumable
ProjectsApi getHubProjects GET /project/v1/hubs/{hub_id}/projects
ProjectsApi getProject GET /project/v1/hubs/{hub_id}/projects/{project_id}
ProjectsApi getProjectHub GET /project/v1/hubs/{hub_id}/projects/{project_id}/hub
ProjectsApi getProjectTopFolders GET /project/v1/hubs/{hub_id}/projects/{project_id}/topFolders
ProjectsApi postStorage POST /data/v1/projects/{project_id}/storage
UserProfileApi getUserProfile GET /userprofile/v1/users/@me Returns the profile information of an authorizing end user.
VersionsApi getVersion GET /data/v1/projects/{project_id}/versions/{version_id}
VersionsApi getVersionItem GET /data/v1/projects/{project_id}/versions/{version_id}/item
VersionsApi getVersionRefs GET /data/v1/projects/{project_id}/versions/{version_id}/refs
VersionsApi getVersionRelationshipsRefs GET /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs
VersionsApi postVersion POST /data/v1/projects/{project_id}/versions
VersionsApi postVersionRelationshipsRef POST /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs
WorkItemsApi createWorkItem POST /autocad.io/us-east/v2/WorkItems Creates a new WorkItem.
WorkItemsApi deleteWorkItem DELETE /autocad.io/us-east/v2/WorkItems('{id}') Removes a specific WorkItem.
WorkItemsApi getAllWorkItems GET /autocad.io/us-east/v2/WorkItems Returns the details of all WorkItems.
WorkItemsApi getWorkItem GET /autocad.io/us-east/v2/WorkItems('{id}') Returns the details of a specific WorkItem.

Thumbnail

Support

[email protected]


All versions of forge-client with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.2
bcartfall/autodesk-core Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bcartfall/forge-client contains the following files

Loading the files please wait ....