-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a65f66f
commit 56ce7a1
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 ;) | ||
|