PHPackages steedy/steedy-client-api-php - 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. steedy/steedy-client-api-php ActiveLibrary steedy/steedy-client-api-php ============================ PHP Wrapper for Steedy API 1.0.5(8y ago)121MITPHPPHP >=5.6 Since Nov 26Pushed 7y agoCompare [ Source](https://github.com/SteedyApp/steedy-client-api-php)[ Packagist](https://packagist.org/packages/steedy/steedy-client-api-php)[ Docs](https://github.com/SteedyApp/steedy-client-api-php)[ RSS](/packages/steedy-steedy-client-api-php/feed)WikiDiscussions master Synced 3d ago READMEChangelog (3)Dependencies (2)Versions (6)Used By (0) steedy-client-api-php ===================== [](#steedy-client-api-php) Steedy PHP Client API You can view the complete API documentation [here](https://apidocs.1steedy.fr/). (only in french atm) Feel free to get in touch for anything you'd like to know. Install ------- [](#install) Via Composer: ``` $ composer require steedy/steedy-client-api-php ``` Usage ----- [](#usage) 1. [Initialize](#initialize) 2. [Create a delivery quote](#create-a-delivery-quote) 3. [Validate a delivery quote](#validate-a-delivery-quote) 4. [Get a delivery status](#get-a-delivery-status) 5. [Cancel a delivery](#cancel-a-delivery) ### Initialize [](#initialize) ``` $client_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // contact us at api@1steedy.fr to initiate your API access $client_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; $api = new \Steedy\API($client_id, $client_secret); // to use the sandbox for testing: // $api = new \Steedy\API($client_id, $client_secret, 'v1-sandbox'); $api->auth(); ``` ### Create a Delivery Quote [](#create-a-delivery-quote) Before you initiate your delivery, you must create a quote for it. **Notice**: You can create a quote with a minimal set of parameters, but we recommend you to set as many information as you can in order to ensure the delivery goes well. ``` $delivery_quote = $api->post('delivery/create', array( 'origin_name' => 'Thomas Rambaud', 'origin_tel' => '0600000000', 'origin_email' => 'thomas@1steedy.fr', 'origin_address' => 'Rue de Rivoli, 75001 Paris', 'origin_commentary' => 'iMac 27 to deliver', 'destinations' => array( array( 'name' => 'Pierre Guerin', 'address' => '16 avenue Reille, 75014 Paris', 'tel' => '0600000000', 'email' => 'pierre@1steedy.fr', ) ) 'delivery_size' => 3 )); ``` ##### With scheduled pickup [](#with-scheduled-pickup) More information about delivery scheduling [on our complete documentation](https://apidocs.1steedy.fr/#tag/Planification). ``` $delivery_quote = $api->post('delivery/create', array( 'origin_name' => 'Thomas Rambaud', 'origin_tel' => '0600000000', 'origin_email' => 'thomas@1steedy.fr', 'origin_address' => 'Rue de Rivoli, 75001 Paris', 'origin_commentary' => 'iMac 27 to deliver', 'destinations' => array( array( 'name' => 'Pierre Guerin', 'address' => '16 avenue Reille, 75014 Paris', 'tel' => '0600000000', 'email' => 'pierre@1steedy.fr', ) ) 'delivery_size' => 3, 'schedule_at' => 1511710610 )); ``` ##### Multiple dropoffs [](#multiple-dropoffs) ``` $delivery_quote = $api->post('delivery/create', array( 'origin_name' => 'Thomas Rambaud', 'origin_tel' => '0600000000', 'origin_email' => 'thomas@1steedy.fr', 'origin_address' => 'Rue de Rivoli, 75001 Paris', 'origin_commentary' => 'iMac 27 to deliver', 'destinations' => array( array( 'name' => 'Pierre Guerin', 'address' => '16 avenue Reille, 75014 Paris', 'tel' => '0600000000', 'email' => 'pierre@1steedy.fr', ), array( 'name' => 'Réginald Cassius', 'address' => '14, villa des Coteaux, 93340 Le Raincy', 'tel' => '0600000000', 'email' => 'reginald@1steedy.fr', 'commentary' => 'Door code: XXXX' ) ) 'delivery_size' => 3 )); // print $delivery_quote['quote_id'] ==> 123 ``` ### Validate a delivery quote [](#validate-a-delivery-quote) Once you successfully created a Delivery Quote, you can validate it. Validating a Quote will trigger its charge process. ``` $validate_result = $api->post('delivery/validate', array( 'quote_id' => $quote_id )); // print $validate_result['order_id'] ==> 123 ``` ### Get a delivery status [](#get-a-delivery-status) You can check your delivery status by querying the `/delivery/follow` endpoint. ``` $follow_result = $api->get('delivery/follow', array( 'order_id' => $order_id )); ``` ### Cancel a delivery [](#cancel-a-delivery) If your delivery has not been accepted by a steedy yet, you can still cancel it, and get refund. Post to `/delivery/cancel` to cancel your delivery order. ``` $cancel_result = $api->post('delivery/cancel', array( 'order_id' => $order_id )); ``` ### Check an address validity [](#check-an-address-validity) It can sometimes be useful for your app or ecommerce site to check if an address is valid and handled by our services. To do so, use the method below. ``` $check_result = $api->post('delivery/is-valid-address', array( 'address' => '16 avenue Reille, 75014 Paris' )); $is_valid_address = isset($check_result['is_valid_address']) && $check_result['is_valid_address'] === TRUE; ``` ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community6 Small or concentrated contributor base Maturity62 Established project with proven stability 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. ### Release Activity Cadence Every ~0 days Total 5 Last Release 3090d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b1d85189540389180698f9ff40119a39a88a53b155b336aa7a42442078eda474?d=identicon)[thomas\_rambaud](/maintainers/thomas_rambaud) --- Top Contributors [![SteedyApp](https://avatars.githubusercontent.com/u/34000148?v=4)](https://github.com/SteedyApp "SteedyApp (21 commits)") ### Embed Badge ![Health badge](/badges/steedy-steedy-client-api-php/health.svg) ``` [![Health](https://phpackages.com/badges/steedy-steedy-client-api-php/health.svg)](https://phpackages.com/packages/steedy-steedy-client-api-php) ``` ### Alternatives [neuron-core/neuron-ai The PHP Agentic Framework. 1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)