https://github.com/preprio/php-rest-sdk
This PHP package is a provider for the Prepr REST API.
https://github.com/preprio/php-rest-sdk
php sdk
Last synced: 4 months ago
JSON representation
This PHP package is a provider for the Prepr REST API.
- Host: GitHub
- URL: https://github.com/preprio/php-rest-sdk
- Owner: preprio
- Created: 2021-02-10T14:39:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T13:33:57.000Z (almost 2 years ago)
- Last Synced: 2025-06-28T16:16:24.951Z (6 months ago)
- Topics: php, sdk
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHP + Prepr SDK
This package is an SDK for the REST API.
## Basics
The SDK on [GitHub](https://github.com/preprio/php-rest-sdk)
Minimal PHP version: `^8.2`
Requires `GuzzleHttp ^7.7.0`
For Laravel projects we recommend using the Laravel providers for [REST](https://github.com/preprio/laravel-rest-sdk) or [GraphQL](https://github.com/preprio/laravel-graphql-sdk).
## Installation
You can install the SDK as a composer package.
```bash
composer require preprio/php-rest-sdk
```
## Making your first request
Let's start with getting some content items from your Prepr environment.
```php
path('content_items')
->query([
'fields' => 'items'
])
->get();
if($apiRequest->getStatusCode() == 200) {
print_r($apiRequest->getResponse());
}
```
To get a single content item, pass the ID to the request.
```php
path('content_items/{id}', [
'id' => '1236f0b1-b26d-4dde-b835-9e4e441a6d09'
])
->query([
'fields' => 'items'
])
->get();
if($apiRequest->getStatusCode() == 200) {
print_r($apiRequest->getResponse());
}
```
### Auto paging results
To get all resources for an endpoint, you can use the auto paging feature.
```php
$apiRequest
->path('content_items')
->query([
'limit' => 200 // optional
])
->autoPaging();
if($apiRequest->getStatusCode() == 200) {
print_r($apiRequest->getResponse());
}
```
### Override the AccessToken in a request
The authorization can also be set for one specific request `->url('url')->authorization('token')`.
### Post
```php
$apiRequest
->path('content_items')
->params([
'body' => 'Example'
])
->post();
if($apiRequest->getStatusCode() == 201) {
print_r($apiRequest->getResponse());
}
```
### Put
```php
$apiRequest
->path('content_items')
->params([
'body' => 'Example'
])
->put();
if($apiRequest->getStatusCode() == 200) {
print_r($apiRequest->getResponse());
}
```
### Delete
```php
$apiRequest
->path('content_items/{id}',[
'id' => "398402d-dd-asd-ads3343dad"
])
->delete();
if($apiRequest->getStatusCode() == 204) {
// Deleted.
}
```
### Multipart/Chunk asset upload
```php
$apiRequest
->path('assets')
->params([
'body' => 'Example',
])
->file('/path/to/file.txt')
->post();
if($apiRequest->getStatusCode() == 200) {
print_r($apiRequest->getResponse());
}
```
### Debug Errors
With `$apiRequest->getRawResponse()` you can get the raw response from the Prepr API.