PHPackages mvnrsa/fibery-apis - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. mvnrsa/fibery-apis ActiveLibrary[API Development](/categories/api) mvnrsa/fibery-apis ================== Implementation of Fibery APIs for Laravel 17PHP Since Feb 24Pushed 2y ago1 watchersCompare [ Source](https://github.com/mvnrsa/FiberyAPIs)[ Packagist](https://packagist.org/packages/mvnrsa/fibery-apis)[ RSS](/packages/mvnrsa-fibery-apis/feed)WikiDiscussions main Synced yesterday READMEChangelogDependenciesVersions (1)Used By (0) Fibery APIs =========== [](#fibery-apis) An implementation of the Fibery APIs for Laravel. (c) 2024 - Marnus van Niekerk - APIs Included ------------- [](#apis-included) - Integrations API - For automatically including your models as entities inside Fibery. - Webhooks - For updating your models from Fibery webhooks whenever fields are changed in Fibery. - REST API - For querying the schema, retrieving, creating and updating entities and creating fields in Fibery. Two-Way Sync ------------ [](#two-way-sync) A *minimalist* form of Two-Way sync can be achieved by combining the Integrations API with Webhooks: 1. Use the Integrations API to include your model as an entity inside Fibery - the fields from Laravel will be **read only**. 2. Add some (shadow) field(s) to that entity in Fibery - these fields will **not** be read only. 3. Set up a webhook to publish changes to the entity back to your Laravel. 4. Configure the webhook handler to update your model's real field(s) from changes to the shadow field(s). 5. Any fields (not the shadow fields) that change in Laravel will be updated in Fibery the next time the Integrations sync runs. This is **not** ideal or perfect, but it's the best that the Fibery APIs can do at the moment. Unfortunately the Fibery Integrations API does not support any updates and it probably won't any time soon. More details are included in the Webhooks section below. ### Caution!! [](#caution) Watch out for creating infinte loops. **Do not** include fields that depend on each other in your webhook config in any way. Installation ------------ [](#installation) Install via composer: ``` composer require mvnrsa/fibery-apis ``` Publish the config file: ``` php artisan vendor:publish --tag=fibery-config ``` Set your Fibery host and api token in `.env`. ``` FIBERY_HOST=yourhost.fibery.io FIBERY_API_TOKEN=your_token ``` If you are planning to use the webhooks you have to publish and run the migrations and seeder. ``` php artisan vendor:publish --tag=fibery-migrations php artisan vendor:publish --tag=fibery-seeders php artisan migrate php artisan db:seed FiberyMapSeeder ``` The `FiberyMap` seeder will connect to Fibery via the API and populate the `fibery_map` table with all of your Fibery types and fields, but without the Laravel model and field names set. You can run this seeder as often as you need to if you add types or fields to Fibery. Authentication and Authorisation -------------------------------- [](#authentication-and-authorisation) Unfortunately the Fibery Integrations and Webhooks APIs do not cater for bearer token authentication (yet), so authentication on the Laravel side is with personal access tokens passed as part of the url (for webhooks) or request variables (for Integrations). As such your application has to support creating personal access tokens for use with these two APIs. Authorisation is via a `Gate` that can be configured in the config file. The default gate is `fibery_access`so you either have to add this gate to your applicaiton or configure it to use another, existing gate. Integrations API ---------------- [](#integrations-api) If all you want is to publish your models to Fibery all you need to do is add your types with the corresponding model classes and fields to the config file and change `integrations_enabled` to `true`. There is a sensible sample of a hypothetical currencies type in the config file. Then simply point your Fibery integration to `https://your.laravel.host/api/fibery` and let Fibery do the rest. :-) The built-in code uses `Model::all()` to fetch all rows and then applies `->only($fields)` to each model to return only the configured fields. Note that you can include any attribute(s) from your model, not only columns from the database, but unfortunately this is not well suited to large datasets (yet). If you want to do something more complex, such as filtering or aggregating your data, you can add a `getFiberyData()`method to your model that returns the items in a two dimensional array. The built-in code checks for and uses the method if it exists. REST API -------- [](#rest-api) The package provides a `mvnrsa\FiberyAPIs\FiberyClient` class that has methods for: 1. Querying the Fibery schema; 2. Listing the fields for any entity type; 3. Adding, querying and updating entities; and 4. Adding, listing and deleting webhooks. Webhooks -------- [](#webhooks) If you are planning to use the webhooks you have to publish and run the migrations and seeder as above and change `webhooks_enabled` to true in the config file. Then you have to edit the rows in the `fibery_map` table to set the laravel model and field names and mark some fields for each model as reference fields. Reference fields are used by the API client to match entities in Fibery to models in Laravel. Then you can call the `add_webhook` method with a type name to generate a unique url and set up the webhook in Fibery. The method accepts a second `tag` parameter which adds a tag to the webhook url to make finding calls in log files easier. Use the `webhooks` method to list any existing webhooks and the `delete_webhook` method to delete one. Note that the webhooks are processed via your default queue using a `FiberyWebhookJob` job. ### Caution [](#caution-1) Note that for the webhooks to really work, you have to have the `fibery_map` set up properly with the Fibery and Laravel entity/model and field names and have some fields marked as reference fields so that the API client can figure out which enities map to which models. Unfortunately the webhook payloads (effects) do not contain enough data on their own to make such a determination so the client has to fetch more fields from Fibery to match *the first time* a specific model is updated. The Fibery IDs of the models are stored using a `FiberyMap` model in the `fibery_map` table which is then used for all subsequent updates. ### Example [](#example) Using our hypothetical Currency model as an example again, Fibery may have a `Code` field that matches the model's `code` column. Then the `Currency/Code` field can be set up to match the `code` column on your `Currency` model and if it is marked as a refernce field the API client will use the Code/code to figure out which model in Laravel matches which entity in Fibery. If you mark multiple fields for a specific model as reference fields they all have to match. ### Health Score 14 — LowBetter than 1% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity19 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/7608c7ee2e454ed881207b21ccc818f5144aa35b91d19e391e03091b80f86944?d=identicon)[mvnrsa](/maintainers/mvnrsa) --- Top Contributors [![mvnrsa](https://avatars.githubusercontent.com/u/31034801?v=4)](https://github.com/mvnrsa "mvnrsa (1 commits)") ### Embed Badge ![Health badge](/badges/mvnrsa-fibery-apis/health.svg) ``` [![Health](https://phpackages.com/badges/mvnrsa-fibery-apis/health.svg)](https://phpackages.com/packages/mvnrsa-fibery-apis) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35916.4M7](/packages/exsyst-swagger)[hubspot/api-client Hubspot API client 24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol An implementation of the Minecraft: Bedrock Edition protocol in PHP 172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram Telegram driver for BotMan 93459.5k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)