Download the PHP package koalati/webflow-api-client without Composer

On this page you can find all versions of the php package koalati/webflow-api-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?

Example code of koalati/webflow-api-client

Informations about the package webflow-api-client

API Client for Webflow's REST API

Latest Version Build Status Latest real-life test Total Downloads

This package provides an API client for Webflow's REST API.

Work in progress

This package is still in the works.

The following issues must be completed before the API client can be considered complete and ready:

If you would like to help, check out the Contributing section below, pick an issue and submit a pull request for it!

Requirements

This package requires PHP 8.1 or above.

Installation

To install, use composer:

Getting started

1. Authenticate with Webflow

To quote Webflow's authentication documentation:

To access the API, you will need to provide an access_token to authenticate with Webflow. You can acquire that token in one of two ways.

  • Utilize OAuth to allow your application’s users to authorize your app to access their Webflow account and data. [...]
  • Issue a Site API Token that grants your application full access to your personal account. Check out our guide on Site API Tokens.

We recommend you opt for OAuth authentication. To set up the OAuth flow, we suggest you use our koalati/oauth2-webflow package.

If you prefer to use Webflow's Site API Token instead, follow the steps on their documentation page that is linked above to get your access token. Please note that you will likely get a more limited access to the API if you chose to go with the Site API Token.

Either way, make sure keep all access tokens secure (e.g. store them in an encrypted format).

2. Instanciate the API client with your access token

3. Start interacting with the API!

If you interact with a single website...

If you interact with a single Webflow site, you can use the SiteClient instead of the basic Client to make your code a bit cleaner.

Both clients offer the exact same feature (Client is actually used internally by the SiteClient), but it saves you from having to pass the site ID with every call.

Here is an example:

Usage

Pagination

Endpoints that are paginated will return a PaginatedList instance. This will prevent you from making more API calls than you really need to.

The first page of results is always fetched to begin with. As you loop over the list, additional API calls will be made to load more data only when you actually get to that point.

If you prefer to fetch all of the data at the beginning, you can use the PaginatedList::fetchAll() method, which loads all of the data and returns it as an array.

Ex.:

Updating data

Models that can be updated via the API, such as Collection Items and Users, track their own changes: all you have to do to update them via their model instance and call their update endpoint with the model once you're ready.

Ex.:

Contributing

Please see CONTRIBUTING for details.

Credits

The core of this package was developed by Koalati, a QA platform for web developers and agencies.

Check out other contributors who helped maintain and make this package better: All Contributors.

License

The MIT License (MIT). Please see License File for more information.

All versions of webflow-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
symfony/http-client Version ^6.2.7
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 koalati/webflow-api-client contains the following files

Loading the files please wait ....