NAV

Introduction

SimplePin's authorization framework enables third-party applications to obtain access to important resources like customers and invoices. Before you get started with making API requests, you have to create a company account. A company in the SimplePin platform represents a business which intends to transact with its customers. Once an account is registered you will obtain your authorization and token, which will be used to identify your company when calling the SimplePin API.

Staging vs Production environment

In order to achieve the highest quality of integration, developers should start by integrating SimplePin's STAGING environment first. Only, after the integration is completed and certified by SimplePin's integration team, the PRODUCTION environment should be configured.

Credentials to access your SimplePin Company account

To start integration, create Company account in Staging environment following the link

https://staging.simplepin.com/company/sign-up-step1

Follow all registration steps and activate your account by validating your email address.

Configuring Authorization and Token keys for API integration

Every API call is identified by secure parameters in headers: Authorization and Token. To configure these parameters, login into SimplePin's Admin interface at https://staging.simplepin.com/company/sign-in and go to Settings / API where you will be presented with a configuration interface.

SimplePin allows developers to create multiple sets of keys to identify different clients.

Webhook notifications

If you would like to receive status update notifications on different events (Payment status, Customer update, Invoice update etc..) you can configure one or multiple urls in Settings / API. 

End-point URL for API calls

As soon as environment is configured you can use the following URL to interact with SimplePin's API: https://staging.simplepin.com/api/v2

Integration steps

Now that everything is ready for you to start integration, follow these integration steps:

  1. 1. In ERP or any business management make sure Customer and Invoice information is ready.
  2. 2. With methods getCustomer, updateCustomer, addCustomer make sure infomation exists in SimplePin database.
  3. 3. With Customer's Policy_ID create new invoice using addInvoice method.