API Quick Start Guide

Understand how to start using of Netcore APIs (V6).

Overview

Welcome to the Netcore API Documentation(V6)! 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 V6 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:

  1. Log in to the Netcore CE dashboard.
  2. Navigate to Profile > User Profile. Locate the API key on this screen.
Unique API Key for your profile

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.

ParameterTypeRequiredDescription
api-keystring✅ YesAPI 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-Typestring✅ YesSpecifies the media type of the request. It must be set to application/json to indicate that the request body contains JSON data.