API Reference

Developer API

An example of the developer experience we design and build — clean REST APIs, SDKs and documentation for the products and platforms we create for clients.

Illustrative reference — sample endpoints and SDKs, not a live public ZGCNS API.

Discuss an integrationView Documentation

Base URL

https://api.example.com

All API requests should be made to the base URL above. Authentication is required for most endpoints.

Authentication

Authorization: Bearer your-api-key

Pass your API key as a Bearer token in the Authorization header on every authenticated request. Need a key? Reach out to get provisioned.

Reference

API endpoints

Every endpoint, with example request and response payloads you can copy straight into your client.

POST/api/contactCommunication

Submit contact form inquiries.

Example request

{
  "name": "John Doe",
  "email": "john@company.com",
  "company": "Acme Corp",
  "countryCode": "+1",
  "phone": "5551234567",
  "subject": "Project Inquiry",
  "message": "Interested in AI implementation",
  "serviceCategories": ["ai-consulting", "software-dev"],
  "preferredContact": "email"
}
POST/api/newsletterCommunication

Subscribe to newsletter updates.

Example request

{
  "email": "user@company.com"
}
POST/api/apply-jobCareers

Submit job applications with resume.

Example request

{
  "name": "Jane Smith",
  "email": "jane@email.com",
  "phone": "5551234567",
  "position": "Senior AI Engineer",
  "experience": "5+ years",
  "coverLetter": "Experienced AI engineer...",
  "resumeFile": "base64_encoded_file"
}
GET/api/healthSystem

System health check endpoint.

Example response

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.0.0"
}
SDKs

SDK examples

Example client libraries illustrating the kind of integration experience we build.

JavaScript

// Example: install the client SDK
npm install @example/sdk

// Initialize the client
import { ApiClient } from '@example/sdk'

const client = new ApiClient({
  apiKey: 'your-api-key',
  baseURL: 'https://api.example.com'
})

// Submit a contact request
const response = await client.contact.submit({
  name: 'John Doe',
  email: 'john@company.com',
  message: 'Project inquiry',
  serviceCategories: ['ai-consulting']
})

Python

# Example: install the client SDK
pip install example-sdk

# Initialize the client
from example_sdk import ApiClient

client = ApiClient(
    api_key='your-api-key',
    base_url='https://api.example.com'
)

# Submit a contact request
response = client.contact.submit({
    'name': 'John Doe',
    'email': 'john@company.com',
    'message': 'Project inquiry',
    'service_categories': ['ai-consulting']
})

cURL

# Submit a contact request
curl -X POST https://api.example.com/contact \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-api-key" \
  -d '{
    "name": "John Doe",
    "email": "john@company.com",
    "message": "Project inquiry",
    "serviceCategories": ["ai-consulting"]
  }'

Need help with integration?

Our technical team can help you integrate ZGCNS APIs into your applications and build custom solutions for your specific requirements.

Contact developer supportCustom integration