API Access

Access the Got2 database using XML-RPC, with explanations, examples, and security tips.

📘 Got2 XML-RPC API Integration

This guide explains how developers can securely and efficiently connect to the Got2 ERP database using XML-RPC The XML-RPC interface is useful when building custom integrations from external systems like mobile apps, third-party services, or data migration tools.

🔧 Prerequisites

Before proceeding, ensure you have:

• Access Got2  and enable XML-RPC enabled.
• A valid Got2 database name.
• A Got2 username and password with sufficient privileges (ideally an API user or admin).
• Python 3 installed.
• xmlrpc.client   module (standard library in Python 3).
• Got2 instance URL (e.g., https://opticalx.got2.cloud   ).

🚀 Step-by-Step Integration

1. Authenticate to Get UID

First, you need to authenticate and obtain a uid   (user ID), which is required for all subsequent calls.

import xmlrpc.client

url = "https://got2.example.com"
db = "got2_production"
username = "api_user@example.com"
password = "your_password"

common = xmlrpc.client.ServerProxy(f"{url}/xmlrpc/2/common")
uid = common.authenticate(db, username, password, {})
print("Authenticated UID:", uid)

2. Access the Object Endpoint

Once authenticated, use the object proxy to call any model methods:

models = xmlrpc.client.ServerProxy(f"{url}/xmlrpc/2/object")

📂 Common Operations

✅ Search Records

# Example: Find all active patients
patient_ids = models.execute_kw(
    db, uid, password,
    'got2.patient', 'search',
    [[['active', '=', True]]]
)

🔎 Search & Read Records

patients = models.execute_kw(
    db, uid, password,
    'got2.patient', 'search_read',
    [[['active', '=', True]]],  # domain
    {'fields': ['name', 'email'], 'limit': 10}
)

📄 Read Specific Record by ID

patient = models.execute_kw(
    db, uid, password,
    'got2.patient', 'read',
    [[15]],  # record ID list
    {'fields': ['name', 'email']}
)

📝 Create a New Record

new_id = models.execute_kw(
    db, uid, password,
    'got2.patient', 'create',
    [{
        'name': 'John Doe',
        'email': 'john@example.com',
        'active': True,
    }]
)

✏️ Update a Record

success = models.execute_kw(
    db, uid, password,
    'got2.patient', 'write',
    [[15], {  # record ID list
        'email': 'updated@example.com'
    }]
)

🗑️ Delete a Record

deleted = models.execute_kw(
    db, uid, password,
    'got2.patient', 'unlink',
    [[15]]  # record ID list
)

🔒 Security Notes

• Do not expose API users publicly.
• Use HTTPS to encrypt all data.
• Limit permissions of the API user (read/write on required models only).
• Rotate passwords regularly and enforce strong credentials.

🧠 Tips and Advanced Use

Check Server Version

version = common.version()
print(version)

Execute Custom Method

Assume got2.patient   has a custom method send_patient_summary   .

models.execute_kw(
    db, uid, password,
    'got2.patient', 'send_patient_summary',
    [[15]]
)

Use fields_get   to Inspect Model

fields = models.execute_kw(
    db, uid, password,
    'got2.patient', 'fields_get',
    [],
    {'attributes': ['string', 'type']}
)

🧪 Debugging & Testing

• Wrap all requests in try/except blocks.
• Log response data for audits.
• Use Postman with raw XML if you want to inspect raw request/response.
• You can also try calling /xmlrpc/2/object   manually with an XML-RPC client.

🗃️ Complete Got2 API Models Reference

👤 Patients & Core Data

🩺 Exams & Prescriptions

🏥 Insurance & Claims

🧾 Products & Pricing

📦 Orders & Billing

📂 Documents, Attachments & Consent

🛠️ Technical / Support Models

🧾 Example: Full Flow to Create and Read a Patient

import xmlrpc.client

url = "https://got2.example.com"
db = "got2_production"
username = "api_user@example.com"
password = "your_password"

common = xmlrpc.client.ServerProxy(f"{url}/xmlrpc/2/common")
uid = common.authenticate(db, username, password, {})

models = xmlrpc.client.ServerProxy(f"{url}/xmlrpc/2/object")

# Create patient
patient_id = models.execute_kw(
    db, uid, password,
    'got2.patient', 'create',
    [{
        'name': 'Jane Smith',
        'email': 'jane@example.com',
    }]
)

# Read patient info
patient_info = models.execute_kw(
    db, uid, password,
    'got2.patient', 'read',
    [[patient_id]],
    {'fields': ['name', 'email']}
)

print(patient_info)