Americommerce4Net / Spark Pay

.Net REST client for the AmeriCommerce / Spark Pay v1 API

Americommerce4Net Dependencies

• .NET Framwork 4 - http://msdn.microsoft.com/en-US/vstudio/aa496123.aspx
• log4net - http://logging.apache.org/log4net/
• Newtonsoft.Json - http://james.newtonking.com/projects/json-net.aspx
• RestSharp - http://restsharp.org/

Americommerce4Net_Tests Dependencies

• Above Dependencies
• NUnit - http://nunit.org/

AmeriCommerce / Spark Pay v1 API Documentation

• https://github.com/SparkPay/rest-api

Namespace

using Americommerce4Net;

Connection

To connect to the API, you need the following credentials:

• Secure URL pointing to a Americommerce store (https://--yourstore--/api/v1)
• Api Access Token

Basic Configuration

var configuration = new Configuration(
								"https://--yourstore--/api/v1",
								"--your api access token--"
								) ;
            
var Client = new Client(configuration);

or

var Client = new Client();  // This will read AppSettings from the App.config

Clients

Main Client includes all clients grouped by functionality

• Client
  • Catalog
  • Content
  • Marketing
  • OrderProc
  • People
  • Settings
  • System
  • Tools

Each of the functionality grouped clients can be used independently, depending on your needs

• ClientCatalog
  • Products
  • ProductVariants
  • ProductPictures
  • Categories
  • Manufacturers
  • Attributes
  • AttributeGroups
  • ProductLists
  • ProductStatuses
  • ShippingRateAdjustments
  • VariantGroups
  • VariantInventory
• ClientContent
  • Pages
  • Blogs
  • BlogCategories
  • BlogPosts
  • Links
• ClientMarketing
  • Adcodes
  • Affiliates
  • Drips
  • DiscountMethods
  • DiscountRules
  • CouponCodes
  • GiftCertificates
  • GiftCertificateTransactions
  • MailingLists
  • EmailTemplates
• ClientOrderProc
  • Carts
  • CartItems
  • Orders
  • OrderItems
  • OrderPayments
  • OrderShipments
  • OrderAddresses
  • Quotes
  • Subscriptions
  • CreditCards
  • OrderStatuses
• ClientPeople
  • Customers
  • Addresses
  • CustomerPaymentMethods
  • CustomerTypes
  • Profiles
  • Users
• ClientSettings
  • UrlRedirects
  • TaxRates
  • PaymentMethods
  • Regions
  • ShippingProviders
  • CustomShippingMethods
  • Warehouses
• ClientSystem
  • Sessions
  • Stores
• ClientTools
  • CustomFields
  • ServerTools

All clients respond with IClientResponse interface

public interface IClientResponse<T>
    {
        T Data { get; set; }
        global::RestSharp.IRestResponse RestResponse { get; set; }
    }

and Data is dynamic {Newtonsoft.Json.Linq.JObject}

Newtonsoft.Json.Linq.JObject.ToObject<T>()

Can use the JObject.ToObject method to deserialized to an object.

Query Syntax / Filters

The filters use fluent interface such as

var client = new ClientCatalog();
var filter = new FilterList()
                .Query(new FilterQuery()
                .FieldName("updated_at")
                .FieldValue(dateTime.To_ISO_8601_DateTime_Format())
                .Compare_GreaterThanOrEqual())
                .ExpandNested("custom_fields", "categories", "pricing", "pictures");
var response = client.Products.Get(filter);

or

var client = new ClientOrderProc();
var filter = new FilterList()
	.Query(new FilterQuery()
	.FieldName("id")
	.FieldValue("0")
	.Compare_GreaterThan())
	.Page(1)
	.Count(100);

var response = client.Orders.Get(filter);

Models

Based on the AmeriCommerce v1 API Documentation, Resource classes are here. Some classes need to be tested a bit more

Reading Store Data

int id = 1;
var client = new ClientCatalog();
var response = client.Products.Get(id);
if (response.Data != null) {
	Americommerce4Net.Models.Product product = response.Data.ToObject<Americommerce4Net.Models.Product>();
	Assert.AreEqual(id, product.id);
}

Updating Store Data

int id = 18;
var obj = new {
	bullets = "<p>Test</p>", 
	item_name = "Natalie Dining Table Set"
	};

var client = new ClientCatalog();
var response = client.Products.Update(id, obj);
if (response.Data != null) {
	Americommerce4Net.Models.Product product = response.Data.ToObject<Americommerce4Net.Models.Product>();
	Assert.AreEqual(id, product.id);
	Assert.AreEqual("<p>Test</p>", product.bullets);
	Assert.AreEqual("Natalie Dining Table Set", product.item_name);
}

Create Store Data

var obj = new {
		item_number = "123456789",
		item_name = "TEST 123456789 Product", 
		price = 99.00, 
		cost = 50.00, 
		retail = 150.00,
		weight = 25.00,
		long_description_1 = "<p>TEST 123456789 Product Long Description</p>"
		};

var client = new ClientCatalog();
var response = client.Products.Create(obj);
if (response.Data != null) {
	Americommerce4Net.Models.Product product = response.Data.ToObject<Americommerce4Net.Models.Product>();
	Assert.AreEqual("123456789", product.item_number);
	Assert.AreEqual("TEST 123456789 Product", product.item_name);
}		

Delete Store Data

Note: Configuration.AllowDeletions must be true

int id = 18;
var client = new ClientCatalog();
var response = client.Products.Delete(id);
Assert.AreEqual(true, response.Data);

Repositories

There are a few Repositories that have been put together to abstract away the clients

var repo = new RepoProduct();
var response = repo.GetAll();
List<Product> products;
if(response.ErrorException == null){
	products = response.Data;
}

The Repositories also has paging & throttling logic built in.

Note:The Repositories require AppSettings in the App.config to be set.

License

Copyright 2015 Ken Worst - R.C. Worst & Company Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.