API Docs
Home
Home
Developer Guide
APIStatusWebhooks
Developer Guide
APIStatusWebhooks
  1. Developer Guide
  • Overview
  • Getting Started
  • Common Errors
  1. Developer Guide

Getting Started

To get started with an API OMS, one of the first steps is to ensure that your application can properly authenticate with the API. This often involves setting an authorization header in your HTTP requests. Here’s a guide on how to set up and use the authorization header for API requests:

Environment Setup (Staging & Production)#

To test the integration with the OMS system, you need to register for the Staging environment before using the production environment.

1. Register for Staging Environment#

Access: https://stg-oms.nandh.vn/
Create an account to obtain your API credentials

2. Account Approval#

After registration, please contact Onflow Customer Support to have your account approved for API access

3. Environment Information#

EnvironmentHost
Stagingstg-oms.nandh.vn
Productionoms.onflow.vn

4. Notes#

Use the Staging environment for testing purposes only
After completing testing, switch to Production (Live) for actual usage
API keys are different between environments

Common Authorization Methods#

1.
Register for API Access
2.
API Key

Setting Up Authorization Headers#

1. Register for API Access#

Contact Onflow to request your API credentials and key. Log in to your account first, as shown in the attached image.
2025-05-24_8-59-56.png

2. API Key#

An API key is a simple encrypted string that identifies the client accessing the API.
Example Header:
Steps:
1.
Obtain the API key from your OMS provider.
2.
Include the API key in the authorization header of your requests.
Example in cURL:
curl -H "Authorization: your_api_key_here" https://api.example.com/orders
Example in Python (using requests library):
Summary
Ensure you understand the specific authorization method required by your OMS API by referring to their documentation. Once authenticated, you can proceed to make API calls to manage orders, inventory, shipments, and other resources provided by the OMS.
Previous
Overview
Next
Common Errors
Built with