PHPackages lucit/lucit-layout-drive-api - 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. lucit/lucit-layout-drive-api ActiveLibrary[API Development](/categories/api) lucit/lucit-layout-drive-api ============================ This is a PHP wrapper composer library for accessing the Lucit Drive Digital Billboard Pull / Pingback Api for Lucit Layout 00PHP Since Jan 16Pushed 2y agoCompare [ Source](https://github.com/lucit-cc/lucit-layout-drive-api)[ Packagist](https://packagist.org/packages/lucit/lucit-layout-drive-api)[ RSS](/packages/lucit-lucit-layout-drive-api/feed)WikiDiscussions master Synced today READMEChangelogDependenciesVersions (1)Used By (0) Deprecated ========== [](#deprecated) This library is deprecated and no longer maintained. Please migrate to V3 of the Lucit api **Resources** - Developer Documentation - V3 Api Docs - Lucit CLI Application Legacy Information ================== [](#legacy-information) The following is left here for legacy installs Lucit Layout Drive Api ---------------------- [](#lucit-layout-drive-api) This is a sample PHP Composer Package which contains a small library for making requests to the V1 Lucit Drive api for export pulls and pingbacks. The full documentation for the Lucit Drive API is located at : Prerequisites ------------- [](#prerequisites) Requires PHP and Composer - Requires a token to the Lucit Layout API Installing ---------- [](#installing) ``` composer require lucit/lucit-layout-drive-api ``` ### What you will need to use this library [](#what-you-will-need-to-use-this-library) - The full URL to the Lucit V1 Api - Currently this is : `https://layout.lucit.cc/api/v1/` - A V1 Api Token (you will be provided this by Lucit) - An export id (you will be provided this by Lucit) - A LOCATION\_ID / Digital Display Id (This is your internal ID that our campaign is scheduled to run on) ### How to fetch a creative [](#how-to-fetch-a-creative) ``` use \Lucit\LucitDrive; $LUCIT_DRIVE_URI = "https://layout.lucit.cc/api/v1/": $LUCIT_DRIVE_TOKEN = "***"; $ld = LucitDrive::Init( $LUCIT_DRIVE_URI, $LUCIT_DRIVE_TOKEN ); $response = $ld->getItem($EXPORT_ID,$LOCATION_ID); ``` The following is a sample response Please take note of the 2 critical data points needed for issuing us play status - `lucit_layout_digital_board_id` - The Lucit internal board id number that maps to your display\\ - `creative_id` the encoded creative id number for this specific image ``` Array ( [location_id] => SC_MH_2 [location_name] => 1414 S. Holloway St. [lucit_layout_digital_board_id] => 19303 [item_count] => 6 [item_total_weight] => 60 [item_selected_index] => 5 [items] => Array ( [0] => Array ( [creative_id] => C1-4C9D-LP-4PcU [creative_datetime] => 2020-07-21T19:15:06+00:00 [id] => 51798 [object_class] => InventoryPhoto [name] => 16914A 2012 Dodge Durango [slug] => 16914a_2012_dodge_durango [src] => https://theimagehost.home/the/path/1/318/img_5f13398aad2d4_d755bcb77855ce7ef665.png [hash] => "d41d8cd98f00b204e9800998ecf8427e" [hash_algo] => "md5" [width] => 1856 [height] => 576 [weight] => 10 [pingback_url] => https://layout.lucit.cc/api/v1/analytics/track/lucit-drive-play/?creative_id=C1-4C9D-LP-4PcU&lucit_layout_digital_board_id=19303&play_datetime=${PLAY_DATETIME_UTC}&play_duration=${PLAY_DURATION_SECONDS}&api_token=${API_TOKEN} [weight_pct] => 0.16666667 ) ) ) ``` How to validate the image response ---------------------------------- [](#how-to-validate-the-image-response) You can validate that the image is the expected image by comparing the `hash` of the image with your own calculated hash of the image file, using the algorithm specified in `hash_algo` You can use our library to do this as follows ``` $ld = LucitDrive::Init( $LUCIT_DRIVE_URI, $LUCIT_DRIVE_TOKEN ); $response = $ld->getItem($EXPORT_ID,$LOCATION_ID); $item = $response["items"][0]; $imageIsValid = $ld->validateItemHash( $item ); if( !$imageIsValid ) { //Throw an exception } ``` How to send playback statistics ------------------------------- [](#how-to-send-playback-statistics) You can send playback stats by usin the library, or, by forming your own request from the `pingback-url` element which appears in the pull result (See docs) ``` use \Lucit\LucitDrive; $LUCIT_DRIVE_URI = "https://layout.lucit.cc/api/v1/": $LUCIT_DRIVE_TOKEN = "***"; $DATE_UTC_ISO8601 = "2020-06-28T18:42:26Z"; //UTC TIME $PLAY_DURATION_SECONDS = 8; $CREATIVE_ID = GetTheCreativeIdFromLastPullResponse(); //This might be like `C1-4C94-IP-4Cu4` `creative_id` $DIGITAL_BOARD_ID = GetTheDigitalBoardIdIdFromLastPullResponse(); //This might be like `12345` `lucit_layout_digital_board_id` $ld = LucitDrive::Init( $LUCIT_DRIVE_URI, $LUCIT_DRIVE_TOKEN ); $response = $ld->play( $CREATIVE_ID, $DIGITAL_BOARD_ID, $DATE_UTC_ISO8601, $PLAY_DURATION_SECONDS); ``` If this is successful you will recieve an OK response ``` Array ( [ok] => 1 ) ``` Testing this composer library ----------------------------- [](#testing-this-composer-library) If you wish to test using this library itself before including it in another application, or, just to use this library to test your provided credentials, export id, and display id 1. Clone this repo to a local directory 2. Run `composer install` 3. Copy `examples/.env.sample.php` to `examples/.env.php` 4. Update `.env.php` with the required settings 5. Run the command `php examples/example-pull.php` and you should see valid output License ------- [](#license) All source code is licensed under the [Apache 2.0 license](LICENSE), the same license as for the Arcanist project. Lucit ----- [](#lucit) Lucit is the company behind Layout : The application that connects big-ticket inventory applications (Automotive, Ag, Rec, Real Estate) to digital billboards, in real-time. We stream inventory - direct, in real-time to digital billboards, anywhere. ### Health Score 12 — LowBetter than 1% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity0 Limited adoption so far Community6 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://avatars.githubusercontent.com/u/50187064?v=4)[Eric](/maintainers/ericlucit)[@ericlucit](https://github.com/ericlucit) --- Top Contributors [![ericlucit](https://avatars.githubusercontent.com/u/50187064?v=4)](https://github.com/ericlucit "ericlucit (15 commits)") ### Embed Badge ![Health badge](/badges/lucit-lucit-layout-drive-api/health.svg) ``` [![Health](https://phpackages.com/badges/lucit-lucit-layout-drive-api/health.svg)](https://phpackages.com/packages/lucit-lucit-layout-drive-api) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M186](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M33](/packages/facebook-php-business-sdk)[microsoft/microsoft-graph The Microsoft Graph SDK for PHP 65723.5M95](/packages/microsoft-microsoft-graph)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)