Understand how to start using of Netcore APIs (V5).
Version Notice: API V5
This documentation covers the latest v5 API version across all modules.
We will be migrating all APIs to this standardized version. Any older API versions will be soon deprecated.
You will receive prior communication regarding the migration schedule and sufficient notice before deprecation to plan your transition smoothly.
Overview
Welcome to the Netcore API Documentation(V5)! Your go-to guide created to streamline your integration and development experience. The documentation provides detailed information on API endpoints, authentication methods, data formats, and usage examples to help you effectively interact with the V5 API.
API Key and Where to Get It
An API key is a unique code that authenticates your API calls and identifies your application or user. An API key is assigned to your account during the onboarding process. To locate your API key, follow the given steps:
- Log in to the Netcore CE dashboard.
- Navigate to Profile > User Profile. Locate the API key on this screen.
Unique API Key for your profile
API Region
Refer to the table given to learn the regional API endpoints available for integration.
API Headers
Refer to the table below for the mandatory HTTP headers necessary for authenticating API requests.
| Parameter | Type | Required | Description |
|---|---|---|---|
api-key | string | ✅ Yes | API key for authentication. You must have a unique and valid API key. This is typically included in the Authorization header as Authorization: x-api-key YOUR_API_KEY. |
Content-Type | string | ✅ Yes | Specifies the media type of the request. It must be set to application/json to indicate that the request body contains JSON data. |