Auditing
This is our process before you can use it for Production Environment
Embedded Files
Request Sandbox Account
Request Sandbox Account
You need to use your Ninjavan Account (Sandbox Environment) to test our API, Please follow all the steps below:
Write an Email to my-sales-enablers@ninjavan.co
Subject: Requesting Sandbox Account
Body/Content :
Hi, my company name is _______________,
this is my Ninja Van account email (if exists): _______________
this is my email (if don't have NV account): ________________
Please give me access to Ninja Van's Sandbox Account. Thank You!
**If you need more than one test account, please mention it in the email.
Once the account is ready we will send a separete email looks like this :
Subject : Sandbox Credential for Integration - {{API Key Name / Shipper Name}}
Get access to Ninja Van Sandbox Dashboard
Get access to Ninja Van Sandbox Dashboard
To log in to our shipper Sandbox dashboard
Head over to https://dashboard-sandbox.ninjavan.co/login-v2
Login to the email with the password provided in the last email.
Go to Settings > IT Settings
API Key Name (Shipper Name)
IF there's no Client ID and Key shown please click "Regenerate Client ID & Key"
Copy both and paste them into your system
View Our NinjaAPI Documentation
View Our NinjaAPI Documentation
To view our API documentation
Head to https://api-docs.ninjavan.co/
For a list of business scenarios that we support and the corresponding API sample payloads, do check out this document that we’ve prepared!
Please take note of our integration requirements!
We will need to check on your sandbox integration, before approving your move to production. We require 3 orders to be generated for every audit of Create Order API and Waybill API
OAuth Access Token API requirement
To set up client API credentials you can view them here
Attach the access token as a bearer token with every API request to Ninja Van API.
Store it in persistent storage (database) or cache and also store the expiration timestamp.
Only generate the token if it is 5 minutes before expires, or if the API request responded with an HTTP 401 error
Create Order API requirement
You are encouraged to retry order creation requests IF an HTTP 5xx error is returned from our API.
If an HTTP 4xx error is returned, please log the response for your debugging purpose, and DO NOT retry the same order creation request without fixing the error specified in the response.
Generate Waybill API requirement
You must cache the waybill upon generation and avoid excessive calls to the waybill API.
If you are generating your own waybill, a Waybill API audit is not necessary.
For the custom waybill, our only requirement is it contains a QR Code of the Tracking Number generated
Webhooks API requirement
Ninja Van Integration Process
Before you start the integration, kindly ensure that you use the right Environment
Sandbox: https://api-sandbox.ninjavan.co/SG
Production: https://api.ninjavan.co/MY
The integration requires you to go through the Sandbox Audit Process for your Production Account to be able to get permission to Create an Order and Generate Waybill (Optional).
If you require to use the Waybill API, do let us know beforehand so that we’ll grant access to the Sandbox Waybill API.
Get Audited
Get Audited
THIS STEP IS COMPULSORY AND IT IS THE DEFAULT SCENARIO
SCENARIO CAN CHANGE AFTER THE AUDIT PROCESS ARE APPROVED
We will send 2 another email (Integration Audit Request: AUD000XX-INT000XX),
one for Order Creation Production API and one for Sandbox Waybill Sandbox API
including the link to proceed with the audit integration request.
Please follow the test scenario below when creating the test orders for integration audit purposes:
* Make sure that you follow the test scenario exactly as in the example below. This is to ensure that you pass our automated system requirements smoothly.
There will be 3 test scenarios for you to test.
You will need to put the 1 tracking number for each test scenario.
Example email :
First email, we will include the Integration Audit Request Link, click it, and then you will go to our audit integration portal.
2. Click Yes for both question and get started. you will needed to put 3 test order in separate 3 scenarios.
3. Once all good you will got this email, we will grant the access by the end of the day.
**
if you got the error such as no api calls//token error//etc
please make an amendment first, and then repeat the first step.
4. Once granted we will send this email
**Repeat the process for WAYBILL API if you have already settle the first link email.
Extra Resources
Extra Resources
If you want an idea or guideline for ui/ux please click here!
Make sure you follow all our steps for granting access
approval to Ninja Van Integration!
Now you are done within all ends, let's get to the marketing plan!
Now you are done within all ends, let's get to the marketing plan!
Page updated
Report abuse