Set up a Sandbox Account

Create a Sage Network API sandbox account and begin using the API today.

1. Create a free developer account
2. Insert a company
3. Query companies

Create a free developer account

Your first step is to create a free developer account on our Sandbox environment. Sage Network API provides a sandbox environment so that you can experiment with API calls without affecting your production data.

In this example, you should replace name, email, and company name with your name and email.

# Step 1 - Begin by creating a free developer account
curl --request POST \
     --url https://api.sbx.lockstep.io/api/v1/Provisioning/free-account \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/*+json'
     --data '
{
     "name": "NAME",
     "email": "EMAIL",
     "companyName": "My Company"
}
'

Insert a company

Let’s begin by creating a record in the Company database to represent a customer.

# Next, you will receive an email with your API key.
# Check your email and save the API key in a safe place.

# Step 2 - Create a company record
#          Remember to put your API key in on line 22!
curl --request POST \
     --url https://api.sbx.lockstep.io/api/v1/Companies \
     --header 'Accept: application/json' \
     --header 'Api-Key: APIKEY' \
     --header 'Content-Type: application/*+json'
     --data '
[
     {
          "erpKey": "ABC123",
          "companyType": "Customer",
          "companyStatus": "Active",
          "isActive": true,
          "defaultCurrencyCode": "USD",
          "address1": "2000 Main Street",
          "city": "Irvine",
          "stateRegion": "CA",
          "postalCode": "92614",
          "country": "USA",
          "companyName": "My Test Company"
     }
]
'

Query companies

Let’s fetch back the company and make sure it was created successfully.

# Step 3 - Let's fetch that company back now!
#          We will use the query "companyName eq 'My Test Company'"
#          Remember to paste in your API key again!
curl --request GET \
     --url 'https://api.sbx.lockstep.io/api/v1/Companies/query?filter=companyName%2520eq%2520%2527My%2520Test%2520Company%2527' \
     --header 'Accept: application/json' \
     --header 'Api-Key: APIKEY'