Skip to main content

​
Overview of GNet Connect API

Welcome to the GNet Connect API documentation, designed to help you integrate and manage key aspects of your business seamlessly. Our APIs are structured to handle everything from user registration, profile management, and data validation to querying and updating company details. GNet Connect APIs are built for flexibility and reliability, with support for real-time data validation, customizable registration workflows, and dry-run validation modes to ensure that your data meets expected standards before going live.

​
Key Concepts

Before diving into the specific endpoints, here are some essential concepts that will help you better understand how the APIs work:

​
GNET ID

  • A unique identifier assigned to every company registered in GNet Connect.
  • Multiple users (e.g., employees) can be associated with the same GNET ID but will have individual emails and phone numbers.
  • All major API operations (e.g., data updates, user lookups) rely on the GNET ID as the primary identifier.

​
Dry Mode vs. Live Mode

  • Dry Mode: Simulates the registration process without actually creating or saving any data in the database.
  • Live Mode: Commits the registration data to the database and generates a unique GNET ID.
  • Dry mode is useful for validation and verification before live registration.

​
Company Data Validation

Our API includes endpoints for checking existing company information, such as verifying email addresses, phone numbers, and company names, to prevent duplicate entries and improve data consistency.

​
API Structure

The GNet Connect API is organized into key modules for ease of navigation:

​
1. User and Company Registration

This module handles:
  • Registering new users and companies
  • Associating users with their corresponding GNET IDs
  • Supporting both dry and live registration modes
Endpoints:
  • POST /api/signup — Create new companies and users

​
2. User and Company Validation

Validation endpoints ensure that no duplicate data is registered in the system. Endpoints:
  • GET /api/checkUser — Check if a user or company already exists using username, email, phone, or GNET ID

​
3. Editing Company Information

Enables updating company profile details such as contact information, addresses, and branding assets. Endpoints:
  • PUT /api/company/edit — Edit and update company details

​
4. Error Handling and Status Codes

All APIs return consistent status codes and error responses to help developers diagnose issues quickly.

​
Authentication

Authentication is required for all endpoints related to modifying or querying sensitive data. The API uses token-based authentication, and developers are expected to pass a valid token in the request headers. Example: 
Authorization: Bearer <your_token>

​
Getting Started

To start integrating the GNet Connect API:
  1. Sign up for an API key: Contact our support team to request access.
  2. Review the endpoints: Explore our documentation for specific API capabilities.
  3. Test using dry mode: We recommend starting with dry mode requests before making live changes.
Ready to get started? Check out the Signup API for details on creating new users and companies.
⌘I