Get Started with API Integration

Quick Links to Resources

API Reference – Technical specifications of Inspectorio Rise API
Organizations data structure – Informative guide describing organizations data structure ***
REST API Integration Steps

To get started with APIs, you will authenticate with a test server API: the Pre-Production Server API. You will test sample organizations integration by making requests to the Pre-Production Server API. Then you will move to the real Production Server API. This will occur in five steps.

Test Server Authentication: Authenticate with the test server API (Pre-Production) using Inspectorio-provided credentials
Integrate Sample Organization: Establish connectivity by POSTing a sample organization
Data Mapping: Agree on data mapping with your Inspectorio Customer Success Manager
Integrate Real Organizations: Send organizations profiles to the test server API with your real data mapped to the Inspectorio API data structures
Production Authentication: Authenticate with our Production Server API

While we are not affiliated with Postman, some clients have had success conducting these five steps using the Postman API Development Environment (which you can download here). This or any other API tool will help you learn how the Inspectorio API functions.

1. Test Server Authentication

The Pre-Production Server API is used for testing API connectivity, correctly map your data with Inspectorio API data structure and streamline integration processes and approaches before moving to Production environment.

Pre-Production Server API URL = https://rise-integration.pre.inspectorio.com/api/v1/...

To start making requests to the test server API, you need to authenticate with the API using credentials provided by your Inspectorio Customer Success Manager. You will input your username and password in JSON format in the request body, point to the auth/login URL on the Test Server API, and send the POST.

{
    "password": "Password123",

    "username": "User1"
}

After POSTing this authentication request successfully, you will receive a response containing a (token). In all requests, you must include the following in every header: a “key” with title = “token”, and “value” = (token) that you just generated in the previous POST.

token: 4e3ic5mw543oo5g583ndfg…

This “key” format is specified in our References page under the Authentication section.

2. Integrate Sample Organization

Once you have successfully authenticated yourself with our test server API and received your (token), you can make your first test API request to ensure proper connectivity. As a reminder, the token should be included as a “key” in the header of each request.

On the References page,

Expand the Organization > POST Create organization method
Extract and modify the JSON content in the request area of technical specification to fulfill all organization data integration requirements or use request body sample specified below
Set the URL as the test server URL: https://rise-integration.pre.inspectorio.com/api/v1/...
Send the request and verify a successful response

To begin with, feel free to use request sample specified below. This sample will create dummy Factory and Partner organizations and allow you to test connectivity with Inspectorio Rise integration layers:

{
  "id": "string",
  "name": "string",
  "type": "factory",
  "address": "string",
  "city": "string",
  "country": "VN",
  "postal": "string",
  "province": "string",
  "latitude": 1.1,
  "longitude": 1.1,
  "contacts": [
    {
      "email": "<[email protected]>",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "1234567890",
      "phoneCountryCode": "084"
    }
  ],
  "partners": [
    {
      "id": "string",
      "name": "string",
      "authorizedCapabilities": [
        1
      ],
      "ior": true,
      "locationStatus": "Pending Transfer",
      "manufacturingTypes": [
        1
      ],
      "registrationDate": "2019-08-23T08:59:39.951Z",
      "registrationStatus": 1,
      "scope": 1
    }
  ]
}

Create Organization API method serves to create organization profile and account on Inspectorio Rise platform thus each organization should be recorded under unique identifier (ID). For this reason, mind inserting your unique identifiers into above sample code for

Factory organization (id field)) and
Partner organization ((partners[].id field))

before submitting the request. Apart from that, given the validation rules that are applied by Inspectorio Rise platform to some fields on the POST organization method, we will be expecting the values present in our sample code. It is important that you follow this step as indicated.

Response that you will receive as a result of above actions will confirm if request was submitted successfully.

3. Data Mapping

Your Inspectorio Customer Success Manager will schedule a phone call with you or someone from your team to align terminologies.

The goal of this meeting is to align your internal data fields to the Inspectorio data fields. Using Inspectorio data fields is required for API Integration. These fields and all data validation rules dictated by Rise platform are outlined in detail on the References page here.

Each company has their own way of processing and storing production chain profiles data. Thus, it is common for companies to have different ways of referring to similar concepts. For example, in Inspectorio, Partner is the term for Supplier or Vendor organizations. It is possible that the data entities “Vendors” or “Suppliers” in your internal system could be mapped to Partner organization type in the Inspectorio data structure. In order for your company to use Inspectorio successfully, it is pivotal that there be alignment between your terminology and ours, especially during data transfer.

4. Integrate Real Organizations

After data mapping, you should be able to test sending multiple organizations profiles with real data to the test server API. In order to make this corroboration step as thorough as possible, we ask that you send at least couple of organizations of each type: partner organizations and factories. At this step, we encourage you to send as many organizations with diverse profiles as possible to see how these will look like in Inspectorio platform.

5. Production Authentication

The Production Server API will be used to transfer live data for actual operations on the platform, so it is important to verify API connectivity with the test server API first. When you are ready to send requests to the Production Server API, your Inspectorio Customer Success Manager will give you corresponding access.

Production Server API URL = [https://rise.inspectorio.com/api/v1/……](https://rise.inspectorio.com/api/v1/auth/login)

You will receive an email with a link inviting you to join Inspectorio. Click on this link and you’ll be taken to a page where you will setup your username and password for the Inspectorio Production Server platform. These credentials will be the ones you use to make requests to our Production Server API. After this point, you can change all instances of Pre-Production Server API URLs to Production Server API URLs in your API requests, and begin by authenticating to generate a Production (token).

Important note These credentials will enable you to access the Production Server API and also platform user interface.

Once you finish these steps, you have officially completed REST API Data Integration.

References

We provide all of the necessary references for you to connect with our API. Find here all of our entities, query parameters, methods, and examples to help you build your code successfully. Find everything you need here.