Why Use the API?

Our API solution is for clients who want full control and seemless integration over the web experience of their subscribers.

How could you benefit from the API?

  • Seamless integration of online ordering without the user leaving your website.
  • Restrict access to some or all of your content to active subscribers.

If you are looking for the easiest route to providing ordering and account services, explore our simplified hosted solution.

API Integration

At NCS Fulfillment, we never want to stand in the way of you and your business information. Our advanced Gateway API allows your software developers to gain direct, real-time access to your circulation file.

Allow your programmers direct access into our system to:

  • Look up subscriber orders
  • Validate subscription status
  • Renew orders
  • Add new orders and charge credit cards

Technical Overview

Our API works by sending RESTful requests over a traditional HTTP SSL connection. Practically any modern programming language is supported, as long as it meets the following two requirements:

  • It must have a serialization library supporting the encoding and decoding of JSON, YAML, or XML;
  • It must be able to post data to and retrieve data from a secure HTTP connection (port 443) authenticating using a client-side SSL certificate. For the easiest experience, we recommend connecting to our web services using libcURL -- a URL connection library with bindings in over 30 languages.

Example Transaction

The following transaction will add a new 12 issue subscription for $10.00. A credit card will be charged and a confirmation email will be sent.

    {
      "Transaction": {
        "BillingFirstName": "CHISTOPHER", 
        "BillingLastName": "CATER", 
        "BillingAddress1": "123 N MAIN ST", 
        "BillingAddress2": "", 
        "BillingCity": "OLIVE BRANCH", 
        "BillingCompanyName": "", 
        "BillingEmail": "demo@example.com", 
        "BillingPhone": "9017633235", 
        "BillingPostalCode": "38375", 
        "BillingState": "MS", 
        "BillingCountryCode": "USA", 
        "PaymentMethod": "Credit Card", 
        "CreditCardExpireMonth": 3, 
        "CreditCardExpireYear": 2014, 
        "CreditCardName": "JASON CATER", 
        "CreditCardNumber": "4111111111111111", 
        "CreditCardSecurityCode": "000", 
        "ExternalReference": "Receipt#12345", 
        "SendConfirmationEmail": true, 
        "TotalAmount": 10.00,
        "Orders": [
          {
            "Copies": 1, 
            "IsGift": false, 
            "Issues": 12, 
            "Retail": 10.00, 
            "SourceKey": "ONLINE", 
            "UseBillingContact": true
          }, 
        ],
      }
    }

On success, you will receive a JSON response with a confirmation number and new account numbers for the subscriber.

Note that for brevity, optional fields were omitted from the above transaction.