Introduction

The Nerotix API is built using RESTful endpoints and standard HTTP verbs. This documentation explains the basic API standards, authentication, security requirements, and endpoint structure required to integrate with the Nerotix API.

API Overview

The API follows standard REST principles and provides a consistent structure for requests and responses.

Response codes are used to indicate the status of the message and any error codes.
JSON is returned on all our API responses, including errors, with a consistent structure for all messages.
Authentication to the API is performed via token-based auth.
Requests to our API should be made as JSON, except when uploading documents.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
All requests must use TLS 1.2 or above, with Server Name Indication enabled.
Text fields support UTF-8, but do not allow certain special characters that could be used maliciously.

Request Format

API requests should be sent using JSON format. The only exception is document upload requests, where the request format may differ depending on the endpoint.

JSON Request

{
    "key": "value"
}

Response Format

All API responses are returned in JSON format, including error responses. Response codes are used to indicate the status of the request and any applicable error codes.

JSON Response

{
    "status": "success",
    "message": "Request processed successfully"
}

Security Requirements

Connection Requirements

Protocol : HTTPS
TLS      : 1.2 or above
SNI      : Required

All API requests must be made over an SSL-enabled HTTPS connection. Calls made over plain HTTP will fail.

Character Encoding

Text fields support UTF-8 encoding. However, certain special characters that could potentially be used maliciously are not permitted.

Need Help?

Need assistance with your integration?

The Nerotix engineers are always available to help with integration-related questions. The quickest way to get help is by contacting us at info@nerotix.in

Endpoints

The API is accessed by making HTTP requests to a specific version endpoint URL. GET or POST variables contain information about what you wish to access.

Every endpoint is accessed via an SSL-enabled HTTPS connection.

Everything including methods, parameters, and other API behaviour is fixed to a version number, and every API call must contain a version.

API Version v1

Different API versions are available at different endpoint URLs. The latest version is Version 1.

BASE URL

https://api.nerofy.in/api

Versioning

Every API request must contain a version number. The API version determines the methods, parameters, and response structure available for that endpoint.