tjsteinhaus/netsuite-php

NetSuite PHP API wrapper orginally built by Ryan Winchester.

Thursday, August 31, 2017
by tjsteinhaus
Repository
1 Watchers
0 Stars
15 Installations

PHP
0 Dependents
0 Suggesters
37 Forks
0 Open issues
20 Versions
25 % Grown

The README.md

NetSuite PHP API Client

, _(*1)

A PHP API client package for NetSuite, pried from the NetSuite PHP Toolkit., _(*2)

Adding it to your project:

Require with composer:, _(*3)

V2 in Alpha, _(*4)

NOTE: package name change, _(*5)

composer require "tjsteinhaus/netsuite-php"

Changes in v2:

Changed namespaces
Significantly simplified NetSuiteClient
Added a convenience method for creating an instance using environment variables for configuration
Improved logging, still logs even if exception is thrown in soap call.

Quickstart:

Instantiating the NetSuiteService class:

The rest of the examples assume that you have done this., _(*6)

require 'vendor/autoload.php';

use NetSuite\NetSuiteService;

$config = array(
   // required -------------------------------------
   "endpoint" => "2017_1",
   "host"     => "https://webservices.netsuite.com",
   "email"    => "jDoe@netsuite.com",
   "password" => "mySecretPwd",
   "role"     => "3",
   "account"  => "MYACCT1",
   "app_id"   => "4AD027CA-88B3-46EC-9D3E-41C6E6A325E2",
   // optional -------------------------------------
   "logging"  => true,
   "log_path" => "/var/www/myapp/logs/netsuite"
);

$service = new NetSuiteService($config);

Retreiving a customer record:

use NetSuite\Classes\GetRequest;
use NetSuite\Classes\RecordRef;

$request = new GetRequest();
$request->baseRef = new RecordRef();
$request->baseRef->internalId = "123";
$request->baseRef->type = "customer";

$getResponse = $service->get($request);

if ( ! $getResponse->readResponse->status->isSuccess) {
    echo "GET ERROR";
} else {
    $customer = $getResponse->readResponse->record;
}

Searching for customers who emails start with "j":

use NetSuite\Classes\SearchStringField;
use NetSuite\Classes\CustomerSearchBasic;
use NetSuite\Classes\SearchRequest;

$service->setSearchPreferences(false, 20);

$emailSearchField = new SearchStringField();
$emailSearchField->operator = "startsWith";
$emailSearchField->searchValue = "j";

$search = new CustomerSearchBasic();
$search->email = $emailSearchField;

$request = new SearchRequest();
$request->searchRecord = $search;

$searchResponse = $service->search($request);

if (!$searchResponse->searchResult->status->isSuccess) {
    echo "SEARCH ERROR";
} else {
    $result = $searchResponse->searchResult;
    $count = $result->totalRecords;
    $records = $result->recordList;

    echo $count . " records were found.";
}

Adding a new customer:

use NetSuite\Classes\Customer;
use NetSuite\Classes\RecordRef;
use NetSuite\Classes\AddRequest;

$customer = new Customer();
$customer->lastName = "Doe";
$customer->firstName = "John";
$customer->companyName = "ABC company";
$customer->phone = "123456789";
$customer->email = "joe.doe@abc.com";

$customer->customForm = new RecordRef();
$customer->customForm->internalId = -8;

$request = new AddRequest();
$request->record = $customer;

$addResponse = $service->add($request);

if (!$addResponse->writeResponse->status->isSuccess) {
    echo "ADD ERROR";
} else {
    echo "ADD SUCCESS, id " . $addResponse->writeResponse->baseRef->internalId;
}

Logging

You can set logging on or off on the fly, or override the configuration setting passed in. Please note that if you don't specify a logging directory in the config or afterwards, then you won't get logs no matter what you do., _(*7)

Set a logging path, _(*8)

$service->setLogPath('/path/to/logs');

Turn logging on, _(*9)

$service->logRequests(true);  // Turn logging on.

Turn logging off, _(*10)

$service->logRequests(false); // Turn logging off.

Token-Based Authentication

Instead of instantiating NetSuiteService with the standard credentials method, you can pass a set of credentials of the form consumerKey/consumerSecret/token/tokenSecret., _(*11)

$config = array(
   // required -------------------------------------
   "endpoint"       => "2017_1",
   "host"           => "https://webservices.netsuite.com",
   "account"        => "MYACCT1",
   "consumerKey"    => "0123456789ABCDEF",
   "consumerSecret" => "0123456789ABCDEF",
   "token"          => "0123456789ABCDEF",
   "tokenSecret"    => "0123456789ABCDEF",
   // optional -------------------------------------
   "signatureAlgorithm" => 'sha256', // Defaults to 'sha256'
);

$service = new NetSuiteService($config);

Status

[x] Extract the ~1500 classes from their single file...
[x] Composer package with autoloading
[x] Pass config through constructor
[x] Optional environment variable config
[x] Namespacing
[x] Logging

License

All additional work is licensed under the Apache 2.0 open source software license according to the included LICENSE file., _(*13)

The Versions

31/08 2017

dev-master

9999999-dev

NetSuite PHP API wrapper orginally built by Ryan Winchester.

library netsuite-php

NetSuite PHP API wrapper orginally built by Ryan Winchester.

tjsteinhaus/netsuite-php

The README.md

NetSuite PHP API Client

Adding it to your project:

Changes in v2:

Quickstart:

Instantiating the NetSuiteService class:

Retreiving a customer record:

Searching for customers who emails start with "j":

Adding a new customer:

Logging

Token-Based Authentication

Status

License

The Versions

dev-master

The Requires

The Development Requires

by Ryan Winchester (fungku)

by Tyler Steinhaus

v2017.2

The Requires

The Development Requires

by Ryan Winchester (fungku)

by Tyler Steinhaus

v2017.1

The Requires

The Development Requires

by Ryan Winchester (fungku)

by Tyler Steinhaus

v2016.2.0

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2016.1.2

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2016.1.1

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2016.1.0

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2.0.4-alpha

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2.0.3-alpha

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2.0.2-alpha

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2.0.1-alpha

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2.0.0-alpha

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2015.2.1

The Requires

The Development Requires

by Ryan Winchester (fungku)

dev-develop

The Requires

The Development Requires

by Ryan Winchester (fungku)

v2015.2.0

The Requires

by Ryan Winchester (fungku)

v2015.1.2