PHPackages preluigi/ontraport - 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. [HTTP & Networking](/categories/http) 4. / 5. preluigi/ontraport AbandonedLibrary[HTTP & Networking](/categories/http) preluigi/ontraport ================== Ontraport PHP Rest API library 0.1.1(10y ago)2681Apache 2.0PHPPHP >=5.6.0 Since Nov 22Pushed 10y ago2 watchersCompare [ Source](https://github.com/preluigi/OntraportPHP)[ Packagist](https://packagist.org/packages/preluigi/ontraport)[ Docs](https://github.com/preluigi/OntraportPHP)[ RSS](/packages/preluigi-ontraport/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (1)Versions (3)Used By (0) OntraportPHP ============ [](#ontraportphp) PHP Library for Ontraport REST API Installation - Using Composer ----------------------------- [](#installation---using-composer) in order to use the library you need to update your require config in composer.json like this ``` "require": { "preluigi/ontraport": "dev-master" }, ``` Simple overview and usage ------------------------- [](#simple-overview-and-usage) First you need to instantiate a new Ontraport object instance with your AppId and Key credentials ``` $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); ``` Then you can access OP objects and their CRUD functions like this ``` $my_contact = $ontraport->Contacts->read ( 55 ); //Where 55 is the ID of the contact print_r ( $my_contact ); /** * Ouputs something like: * stdClass Object * ( * [code] => 0 * [data] => stdClass Object * ( * [name] => Customer Name * [price] => 119.95 * [id] => 340 * [owner] => 2 * [firstname] => * [lastname] => * [email] => * [address] => * [city] => * [state] => * [zip] => * [birthday] => * [date] => 1448207931 * [notes] => * [status] => * [category] => * [lead_source] => * ) * [updates] => Array * ( * ) * [notifications] => Array * ( * ) * [account_id] => 27801 * ) **/ $new_product = array ( 'name' => 'An awesome product!', 'price' => 119.95 ); $result = $ontraport->Products->create ( $new_product ); print_r ( $result ); /** * Outputs something like: * stdClass Object * ( * [code] => 0 * [data] => stdClass Object * ( * [name] => An awesome product! * [price] => 119.95 * [id] => 19 * ) * * [updates] => Array * ( * ) * * [notifications] => Array * ( * ) * * [account_id] => 27801 * ) **/ ``` Supported Ontraport Object Types -------------------------------- [](#supported-ontraport-object-types) Currently the following Ontraport Object Types are supported: - Contacts - Notes - Objects - Products - Purchases - Shippings - Staff - Tags - Taxes You can access them using the already seen syntax ``` $ontraport->{Object type classname, eg: Contacts}->{method to call} ``` Object Types methods -------------------- [](#object-types-methods) Every Object Type has the following default methods - `find ( string $field, mixed $value, string $operand = '=', string $type = 'auto' )` - `create ( array $attrs )` - `read ( int $id )` - `get ( array $ids )` - `update ( object $object )` - `delete ( int $id )` Changing the API version ------------------------ [](#changing-the-api-version) By default the library uses the version 1 of the REST API (which is the only one available at this moment). You can change the version to fit your needs (???) by using the Ontraport\\Ontraport->set\_version method: ``` $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); $ontraport->set_version ( '2.1.2' ); ``` Changing the default endpoints ------------------------------ [](#changing-the-default-endpoints) By default the library initializes the following endpoints: ``` array ( 'object' => "https://api.ontraport.com/1/object", 'objects' => "https://api.ontraport.com/1/objects", 'objects_meta' => "https://api.ontraport.com/1/objects/meta", 'objects_tag' => "https://api.ontraport.com/1/objects/tag", 'form' => "https://api.ontraport.com/1/form", 'message' => "https://api.ontraport.com/1/message", 'task_cancel' => "https://api.ontraport.com/1/task/cancel", 'task_complete' => "https://api.ontraport.com/1/task/complete", 'transaction_processmanual' => "https://api.ontraport.com/1/transaction/processManual", 'transaction_refund' => "https://api.ontraport.com/1/transaction/refund", 'transaction_converttodecline' => "https://api.ontraport.com/1/transaction/convertToDecline", 'transaction_converttocollections' => "https://api.ontraport.com/1/transaction/convertToCollections", 'transaction_void' => "https://api.ontraport.com/1/transaction/void", 'transaction_voidpurchase' => "https://api.ontraport.com/1/transaction/voidPurchase", 'transaction_reruncommission' => "https://api.ontraport.com/1/transaction/rerunCommission", 'transaction_markpaid' => "https://api.ontraport.com/1/transaction/markPaid", 'transaction_rerun' => "https://api.ontraport.com/1/transaction/rerun", 'transaction_writeoff' => "https://api.ontraport.com/1/transaction/writeOff", 'transaction_order' => "https://api.ontraport.com/1/transaction/order", 'transaction_resendinvoice' => "https://api.ontraport.com/1/transaction/resendInvoice" ); ``` You can change one or all of those endpoints by using the Ontraport\\Ontraport->set\_endpoint method: ``` $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); $my_endpoints = array ( 'object' => "my_custom_endpoint_for_single_object", 'objects' => "my_custom_endpoint_for_multiple_objects", ); $ontraport->set_endpoint ( $my_endpoints ); // Will only change the endpoints defined in $my_endpoints $ontraport->set_endpoint ( $my_endpoints, true ); // Will substitute all endpoints with only those defined in $my_endpoints ``` Note that custom defined endpoints will **not** use the API version attribute to generate the called endpoint, so you need to pass the complete endpoint URI. How the library works --------------------- [](#how-the-library-works) Before you start diving into more advanced OntraportPHP usages I bet you want to see in detail how the library works. So here's the answer: The library itself is composed by a set of classes organized by that pattern: class **Ontraport** --calls--> class **Contacts** which extends class **Objects** at the moment the library supports only operations on Ontraport Object Types; base CRUD methods are defined in the Ontraport\\Objects class which is extended by object specific classes like Contacts or Products. So when you call ->Contacts->read() on an Ontraport\\Ontraport object you're simply receiving the results from the Ontraport\\Contacts->read() method which is inherited from the Ontraport\\Objects class. Behind the scenes is going on a dependency injection from the class Ontraport\\Ontraport object to the called class (eg: Ontraport\\Contacts), in fact here there are two working examples: ``` $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); /* * Outputs the object representing contact with id=55 */ print_r ( $ontraport->Contacts->read ( 55 ) ); $contacts = new Ontraport\Contacts ( $ontraport ); /* * Outputs the same object as above */ print_r ( $contacts->read ( 55 ) ); ``` Extend the library ------------------ [](#extend-the-library) I suggest you to read the preceding section: **How the library works** to better understand the following instructions. There are basically two ways to extend the library with you own classes: **1) By using a custom namespace (Recommended)** The Ontraport\\Ontraport class exposes a method called **set\_namespace** which you can use to modify the namespace of the called Object Type classes, I think is better have an example: ``` namespace MyNamespace; // Using a custom namespace include ( __DIR__ . '/vendor/autoload.php' ); // Including the composer autoload /* * Defining a MyNamespace\Contacts class which extends Ontraport\Contacts */ class Contacts extends Ontraport\Contacts { // Overriding the parent method public function read ( $id ) { $result = parent::read ( $id ); // Adding the "example_field" to parent called method object result $result->data->example_field = 'Test'; return $result; } } $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); $ontraport->Contacts->read ( 55 ); // Will return the Contact object with ID=55 /* * Changing the base namespace where Ontraport\Ontraport looks for class inclusion */ $ontraport->set_namespace ( 'MyNamespace' ); $ontraport->Contacts->read ( 55 ); // Will return the Contact object with ID=55 and added field "example_field" ``` Using this approach you can override any Object Type class and define your own while mantain the $ontraport->ClassName clear and compact syntax. **2) By using dependency injection** This method works the same as the first mentioned but instead of changing the base namespace used for inclusion you've got to extend Object Type classes and use dependency injection to pass the Ontraport\\Ontraport object to the class constructor. Example: ``` namespace MyNamespace; // Using a custom namespace include ( __DIR__ . '/vendor/autoload.php' ); // Including the composer autoload /* * Defining a MyNamespace\Contacts class which extends Ontraport\Contacts */ class Contacts extends Ontraport\Contacts { // Overriding the parent method public function read ( $id ) { $result = parent::read ( $id ); // Adding the "example_field" to parent called method object result $result->data->example_field = 'Test'; return $result; } } $ontraport = new Ontraport\Ontraport ( 'my_app_id', 'my_app_key' ); $contacts_object = new Contacts ( $ontraport ); $contacts_object->read ( 55 ); // Will return the Contact object with ID=55 and added field "example_field" ``` ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community9 Small or concentrated contributor base Maturity49 Maturing project, gaining track record 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 2 Last Release 3820d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3462c326bca7f8ede6747e94c73ba799d94528a4bfafea2fe8a05addd6ca178e?d=identicon)[preluigi](/maintainers/preluigi) --- Top Contributors [![preluigi](https://avatars.githubusercontent.com/u/7706214?v=4)](https://github.com/preluigi "preluigi (11 commits)") --- Tags phprestontraport ### Embed Badge ![Health badge](/badges/preluigi-ontraport/health.svg) ``` [![Health](https://phpackages.com/badges/preluigi-ontraport/health.svg)](https://phpackages.com/packages/preluigi-ontraport) ``` ### Alternatives [abantecart/ups-php UPS PHP SDK based on OAuth 1815.3k](/packages/abantecart-ups-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)