Mobile API Documentation

Getting started with IDEX mobile API's

Overview: After your initial login, each API call should include your session code.

Environments

Development, Staging & Production
Use our staging environment for development and testing.
Staging environment will be at "https://staging-mobapi.idexonline.com".
Production environment will be on "https://mobapi.idexonline.com".

Staging environment is contained, and only developers and QA will see the data. We can prepare specific use-case scenarios as needed. Staging will not send emails to customers.

Security measures

abuse prevention
In order to be able to stop uninteded use of these API's, you need to use an "app_key", which you need for requests that do not include authentication, including login. This app_key will change from time to time.
To begin with, use IMAfRtQ24B for iOS, and IMAb0t24B for android.

Input Parameters

In general, all parameters are mandatory with every API call. With the exception of search filters.
Parameter Description
session_code string you got back from your authentication. You can find details of how to authenticate here.

Sample Request

HTTP JSON
Endpoint: section/api/v2.0/method
{
	"session_code":"MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
	"name_param": "value param"
}

Sample Response

JSON Data
If all goes well, the HTTP code will be 200 and in the result info the reponse_code will be 0.
{
	"result_info": {
		"response_code": 0,
		"response_description": ""
	},
	"results": {
		"total_items_available": 321,
		"items_included": 2,
		"diamonds": [
			{
				"diamond_id": 124298419,
				"shape": "Round",
				"weight": 1.2,
				"color": "F",
				"clarity": "VVS1",
				"row_number": 1
			},
			{
				"diamond_id": 128712167,
				"shape": "Princess",
				"weight": 1.13,
				"color": "F",
				"clarity": "VVS1",
				"row_number": 2
			}
		]
	}
}
		
In case of an exception, the error message will be displayed in this format. If there is an unexpected error, the HTTP code will be 500.
{
	"result_info": {
		"response_code": 32110,
		"response_description": "A description of the exception."
	}
}
		
Example for expired session:
{
	"result_info": {
		"response_code": 62199,
		"response_description": "Invalid or expired session."
	}
}
		

© IDEX Online 2024   -   www.idexonline.com