\ShapewaysClient

API Client for obtaining OAuth token/secret and making API calls to api.shapeways.com

Summary

Methods

Properties

Constants

__construct()
connect()
verify()
verifyUrl()
url()
addModel()
addModelFile()
addModelPhoto()
addToCart()
deleteModel()
getPrice()
getApiInfo()
getCart()
getCategories()
getCategory()
getMaterial()
getMaterials()
getModel()
getModelFile()
getModelInfo()
getModels()
getPrinter()
getPrinters()
updateModelInfo()

$callbackUrl
$consumerKey
$consumerSecret
$_client
$oauthToken
$oauthSecret
$baseUrl
$apiVersion

No constants found

No protected methods found

No protected properties found

N/A

_get()
_put()
_post()
_delete()

No private properties found

N/A

File: Client.php
Package: \Default
Class hierarchy: \Shapeways\Client

Tags

todo

Properties

$callbackUrl

$callbackUrl : string

Type

string — the oauth callback url

Tags

todo

$consumerKey

$consumerKey : string

Type

string — the oauth consumer key

Tags

todo

$consumerSecret

$consumerSecret : string

Type

string — the oauth consumer key

Tags

todo

$_client

$_client : string

Type

string — the \OAuth client instance

Tags

todo

$oauthToken

$oauthToken : string

Type

string — the oauth token used for requests

Tags

todo

$oauthSecret

$oauthSecret : string

Type

string — the oauth token used for requests

Tags

todo

$baseUrl

$baseUrl : string

Type

string — the api base url used to generate api urls

Tags

todo

$apiVersion

$apiVersion : string

Type

string — the api version used to generate api urls

Tags

todo

Methods

__construct()

__construct(string $consumerKey, string $consumerSecret, string|null $callbackUrl, string|null $oauthToken, string|null $oauthSecret)

Create a new \Shapeways\Client

Parameters

string	$consumerKey	your app consumer key
string	$consumerSecret	your app consumer secret
string\|null	$callbackUrl	your app callback url
string\|null	$oauthToken	a users oauth token if it is already known
string\|null	$oauthSecret	a users oauth secret if it is already known

Tags

todo

connect()

connect() : string|bool

Get request token and authentication url to send user to

Returns

string|bool —

the authentication url or false if it failed

Tags

todo

verify()

verify(string $token, string $verifier) : bool

Get an access token from the oauth authentication callback

Parameters

string	$token	the oauth_token in the auth callback query string
string	$verifier	the oauth_verifier in the auth callback query string

Returns

bool

Tags

todo

verifyUrl()

verifyUrl(string $url) : bool

Get an access token from the raw oauth authentication callback uri this method will parse the oauth_token and oauth_verifier from the query string for you.

Parameters

string

$url

the raw auth callback uri (e.g. $_SERVER['REQUEST_URI'])

Returns

bool

Tags

todo

url()

url(string $path) : string

Generate a correct full api url from just the api part.

Parameters

string

$path

the api path (e.g. '/orders/cart/')

Returns

string

Tags

todo

addModel()

addModel(array $params) : array

Upload a model for the user

https://developers.shapeways.com/docs#POST_-models-v1

Parameters

array

$params

the model data to set

Returns

array —

the json response from the api call

Tags

todo

addModelFile()

addModelFile(int $modelId, array $params) : array

Add a new file for the model

https://developers.shapeways.com/docs#POST_-models-modelId-files-v1

Parameters

int	$modelId	the modelId for the model
array	$params	the file data to upload

Returns

array —

the json response from the api call

Tags

todo

addModelPhoto()

addModelPhoto(int $modelId, array $params) : array

Upload a new photo for the model

https://developers.shapeways.com/docs#POST_-models-modelId-photos-v1

Parameters

int	$modelId	the modelId for the model to associate the photo with
array	$params	the photo data to upload

Returns

array —

the json response from the api call

Tags

todo

addToCart()

addToCart(array $params) : array

Add a model to the users shopping cart

https://developers.shapeways.com/docs#POST_-orders-cart-v1

Parameters

array

$params

the model data for adding to the cart

Returns

array —

the json response from the api call

Tags

todo

deleteModel()

deleteModel(int $modelId) : array

Remove the users model with the given $modelId

https://developers.shapeways.com/docs#DELETE_-models-modelId-v1

Parameters

int

$modelId

the modelId of the model to remove

Returns

array —

the json response from the api call

Tags

todo

getPrice()

getPrice(array $params) : array

Calculate the price from the provided parameters

https://developers.shapeways.com/docs#POST_-price-v1

Parameters

array

$params

the parameters used to calculate the price

Returns

array —

the json response from the api call

Tags

todo

getApiInfo()

getApiInfo() : array

Get the current api info

https://developers.shapeways.com/docs#GET_-api-v1-

Returns

array —

the json response from the api call

Tags

todo

getCart()

getCart() : array

Get the users shopping cart

https://developers.shapeways.com/docs#GET_-orders-cart-v1

Returns

array —

the json response from the api call

Tags

todo

getCategories()

getCategories() : array

Get a list of all categories

https://developers.shapeways.com/docs#GET_-categories-v1

Returns

array —

the json response from the api call

Tags

todo

getCategory()

getCategory(int $catId) : array

Get information for the provided categoryId

https://developers.shapeways.com/docs#GET_-categories-categoryId-v1

Parameters

int

$catId

the categoryId to get the information for

Returns

array —

the json response from the api call

Tags

todo

getMaterial()

getMaterial(int $materialId) : array

Get information for the provided materialId

https://developers.shapeways.com/docs#GET_-materials-materialId-v1

Parameters

int

$materialId

the materialId to get information for

Returns

array —

the json response from the api call

Tags

todo

getMaterials()

getMaterials() : array

Get a list of materials

https://developers.shapeways.com/docs#GET_-materials-v1

Returns

array —

the json response from the api call

Tags

todo

getModel()

getModel(int $modelId) : array

Get a model

https://developers.shapeways.com/docs#GET_-models-modelId-v1

Parameters

int

$modelId

the modelId

Returns

array —

the json response from the api call

Tags

todo

getModelFile()

getModelFile(int $modelId, int $fileVersion, bool $includeFile) : array

Get a model's file

https://developers.shapeways.com/docs#GET_-models-modelId-files-fileVersion-v1

Parameters

int	$modelId	the modelId which the file belongs to
int	$fileVersion	the file version
bool	$includeFile	whether or not to include the raw file in the response (default: False)

Returns

array —

the json response from the api call

Tags

todo

getModelInfo()

getModelInfo(int $modelId) : array

Get information for the provided modelId

https://developers.shapeways.com/docs#GET_-models-modelId-info-v1

Parameters

int

$modelId

the modelId for the model to retreive

Returns

array —

the json response from the api call

Tags

todo

getModels()

getModels(int $page) : array

Get a list of models

https://developers.shapeways.com/docs#GET_-models-v1

Parameters

int

$page

the page of models to get (default: 1)

Returns

array —

the json response from the api call

Tags

todo

getPrinter()

getPrinter(int $printerId) : array

Get the information for the provided printerId

https://developers.shapeways.com/docs#GET_-printers-printerId-v1

Parameters

int

$printerId

the printerId for the printer you want to get info for

Returns

array —

the json response from the api call

Tags

todo

getPrinters()

getPrinters() : array

Get the full list of printers available

https://developers.shapeways.com/docs#GET_-printers-v1

Returns

array —

the json response from the api call

Tags

todo

updateModelInfo()

updateModelInfo(int $modelId, array $params) : array

Update a models information

https://developers.shapeways.com/docs#PUT_-models-modelId-info-v1

Parameters

int	$modelId	the modelId of the model to update
array	$params	the values to update

Returns

array —

the json response from the api call

Tags

todo

_get()

_get(string $url, array $params) : array

Make a GET request to the api server

Parameters

string	$url	the api url to request
array	$params	the parameters to send with the request

Returns

array —

the json response from the api call

Tags

todo

_put()

_put(string $url, array $params) : array

Make a PUT request to the api server

Parameters

string	$url	the api url to request
array	$params	the parameters to send with the request

Returns

array —

the json response from the api call

Tags

todo

_post()

_post(string $url, array $params) : array

Make a POST request to the api server

Parameters

string	$url	the api url to request
array	$params	the parameters to send with the request

Returns

array —

the json response from the api call

Tags

todo

_delete()

_delete(string $url, array $params) : array

Make a DELETE request to the api server

Parameters

string	$url	the api url to request
array	$params	the parameters to send with the request

Returns

array —

the json response from the api call

Tags

todo