Skip to content

Commit

Permalink
Create README.md, add psr-4 autoload
Browse files Browse the repository at this point in the history
  • Loading branch information
wivern-co-uk committed Aug 23, 2018
1 parent a65f66f commit ef19e6a
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 14 deletions.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# PHP SDK for the Webflow CMS API
Implementation based on [Webflow CMS API Reference](https://developers.webflow.com/#cms-api-reference)

## Features implemented
- Get Current Authorization Info
- List Sites
- Get Specific Site
- Publish Site
- List Domains
- List Collections
- Get Collection with Full Schema
- **Get All Items for a Collection (including paginated results)**
- **Find one or Create Item by Name**
- Get Single Item
- Create New Collection Item
- Update Collection Item
- Patch Collection Item
- Remove Collection Item

## Usage

Check https://university.webflow.com/article/using-the-webflow-cms-api on how to generate `YOUR_WEBFLOW_API_TOKEN`

### Get Current Authorization Info
```
$webflow = new \Webflow\Api('YOUR_WEBFLOW_API_TOKEN');
$webflow->info();
```

### List Sites
```
$webflow->sites();
```

### List Collections
```
$webflow->collections();
```

### Get All Items for a Collection (including paginated results)
```
$webflow->itemsAll($collectionId);
```
### Get Single Item
```
$webflow->item($collectionId, $itemId);
```

### Create New Collection Item
```
$fields = [
'name' => 'New item created via API',
# ...
];
$webflow->createItem($collectionId, $fields);
```

### Update Collection Item
```
$webflow->updateItem($collectionId, $itemId, $fields);
```

### Remove Collection Item
```
$webflow->removeItem($collectionId, $itemId);
```


## Installation

```
# Install Composer
composer require expertlead/webflow-php-sdk
```
No extra dependencies! You are welcome ;)

33 changes: 19 additions & 14 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
{
"name": "expertlead/webflow-php-sdk",
"description": "PHP SDK for the Webflow CMS API",
"type": "library",
"require": {
"ext-curl": "*"
},
"license": "MIT",
"authors": [
{
"name": "Oleksii Antypov",
"email": "[email protected]"
}
],
"minimum-stability": "stable"
"name": "expertlead/webflow-php-sdk",
"description": "PHP SDK for the Webflow CMS API",
"type": "library",
"require": {
"ext-curl": "*"
},
"license": "MIT",
"authors": [
{
"name": "Oleksii Antypov",
"email": "[email protected]"
}
],
"autoload": {
"psr-4": {
"Webflow\\": "src/"
}
},
"minimum-stability": "stable"
}

0 comments on commit ef19e6a

Please sign in to comment.