REST API

शक्तिशाली इंटीग्रेशन बनाएं।

प्रति-की प्रमाणीकरण से सुरक्षित एक वर्शन्ड JSON REST API। जॉब्स, इनवॉइस, पेमेंट, एस्टिमेट और ग्राहकों से जुड़े 12 इवेंट्स के लिए webhooks सब्सक्राइब करें। Scale टियर पर उपलब्ध।

प्रति-की ऑथेंटिकेशन वर्शन्ड REST · v1 12 webhook इवेंट्स 5 अधिकार-क्षेत्र
bash · REST API के ज़रिए एक जॉब बनाएं
curl https://api.servicesynchq.com/api/v1/jobs \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 12345,
    "scheduledDate": "2026-08-20T14:00:00Z",
    "title": "HVAC repair"
  }'
json · रिस्पॉन्स · स्ट्रीमिंग हो रही है
201 Created
{  "id": 84213,  "customerId": 12345,  "status": "scheduled",  "scheduledDate": "2026-08-20T14:00:00Z",  "title": "HVAC repair",  "createdAt": "2026-07-24T08:14:22Z"}
REST API · v1
स्थिर, वर्शन्ड, JSON
X-API-Key
प्रति-की ऑथेंटिकेशन
पूर्ण CRUD
आपके सभी डेटा में
12 इवेंट्स
रियल-टाइम webhooks
API रेफरेंस

प्रमुख एंडपॉइंट्स

आपके डेटा की एक झलक। ग्राहक, जॉब्स, इनवॉइस, एस्टिमेट, भुगतान, इन्वेंट्री, शेड्यूलिंग और नोटिफिकेशन — सभी JSON पर पूर्ण CRUD उपलब्ध कराते हैं।

REST · /api/v1

JSON पर पूरा CRUD — सुरक्षित रखती है आपकी X-API-Key

/customers/jobs/estimates /invoices/payments/inventory
Webhooks · 12 इवेंट्स

एक एंडपॉइंट रजिस्टर करें और रियल-टाइम में एक्शन लें।

job.createdinvoice.paidpayment.received estimate.acceptedcustomer.created

इंटीग्रेट करने के दो तरीके — रीड/राइट के लिए REST, रियल-टाइम पुश के लिए webhooks।

200 OK GET

/api/v1/customers

सभी ग्राहकों की सूची।

कर्सर-पेजिनेटेड
201 Created POST

/api/v1/customers

एक नया कस्टमर बनाएं।

idempotency-key समर्थित
200 OK GET

/api/v1/jobs

स्टेटस या तारीख के आधार पर फ़िल्टर किए गए जॉब्स की सूची।

सॉर्ट व फ़िल्टर योग्य
201 Created POST

/api/v1/jobs

नया जॉब शेड्यूल करें। यह ट्रिगर करता है job.created webhook।

ऑडिट-लॉग में दर्ज
200 OK GET

/api/v1/invoices

पेजिनेशन के साथ इनवॉइस की सूची।

अधिकार-क्षेत्र-सजग
202 Accepted POST

/api/v1/invoices/:id/send

ईमेल या SMS के ज़रिए इनवॉइस भेजें। IN के लिए IRN अपने-आप जनरेट होता है।

retry-queue समर्थित

ग्राहक · जॉब्स · एस्टिमेट · इनवॉइस · पेमेंट · इन्वेंट्री · खरीद · शेड्यूलिंग · नोटिफिकेशन का एक प्रतिनिधि नमूना। हर विशेषाधिकृत कॉल audit-logged होती है। पूरा रेफ़रेंस देखें →

वैश्विक अनुपालन · C7

5 अधिकार-क्षेत्र, एक ही API सतह

बस एक कंट्री कोड पास करें और पाएं सही टैक्स गणना, सही डॉक्यूमेंट लेआउट, सही e-invoice payload। वही endpoints, अधिकार-क्षेत्र के अनुसार व्यवहार — आपके इंटीग्रेशन कोड में हर देश के लिए अलग कोड की ज़रूरत नहीं।

भारत GSTUS सेल्स टैक्सUK VATEU VATGCC VAT
IN भारतCGST + SGST राज्य के भीतर · IGST अंतर-राज्यीय · IRN e-invoice (24 घंटे की रद्दीकरण विंडो) · HSN कोड
UK यूनाइटेड किंगडमCIS विदहोल्डिंग 20% / 30% / 0% (रजिस्ट्रेशन स्थिति के अनुसार अपने-आप कटौती) · VAT रिटर्न
EU EU (SDI XML)इटैलियन SDI XML e-invoice फ़ॉर्मेट · सीमा-पार VAT रूटिंग · रिवर्स-चार्ज
SA KSA (ZATCA फेज़ 1)द्विभाषी अरबी/अंग्रेज़ी · 5 अनिवार्य टैग वाला TLV QR कोड · VAT 15%
AE UAE / GCCVAT 5% · अरबी इनवॉइस सपोर्ट · FTA अनुपालन फ़ील्ड्स
CA कनाडाGST · HST · PST · QST प्रांत के अनुसार रूटिंग · CRA-तैयार इनवॉइस
AU ऑस्ट्रेलिया10% GST · ABN विदहोल्डिंग 49% (बिना-ABN सप्लायर)
US संयुक्त राज्य अमेरिकाराज्य सेल्स टैक्स रूटिंग · गंतव्य/मूल · रीसेल सर्टिफ़िकेट हैंडलिंग
टैक्स इंजन

अनुपालन की गणना, स्वचालित

बस अपना इरादा बताइए — सही टैक्स ब्रेकडाउन की गणना हम कर देते हैं। राज्य बदले, रजिस्ट्रेशन बदले या अधिकार-क्षेत्र टॉगल हो — ये सब डेटा हैं, कोड नहीं। बैंकिंग-स्तर का आइसोलेशन: हर कस्टमर का डेटा अपने अलग लॉजिकल वॉल्ट में रहता है — डेटाबेस खुद वॉल्ट्स के बीच डेटा मिलाने से इनकार करता है, सिर्फ़ ऐप कोड ही नहीं।

राज्य के भीतर बनाम अंतर-राज्यीय रूटिंग

आपूर्तिकर्ता का राज्य ग्राहक के समान? CGST + SGST। अलग? IGST। गणना इससे होती है — company.state बनाम customer.state

भारत GST IRN ई-इनवॉइस

POST पर IRN + हस्ताक्षरित QR जनरेट करता है। 24h cancellation window समर्पित एंडपॉइंट के ज़रिए उपलब्ध। HSN कोड लुकअप के ज़रिए।

UK CIS कटौती

अपने-आप कटौती करता है 20% / 30% / 0% प्रत्येक सबकॉन्ट्रैक्टर के लिए, कॉन्ट्रैक्टर की पंजीकरण स्थिति के आधार पर।

KSA ZATCA TLV QR

Phase 1 द्विभाषी इनवॉइस + TLV QR, जो एन्कोड करता है सभी 5 mandatory tags। रेंडर से पहले ZATCA के विरुद्ध सत्यापित करता है।

प्रमाणीकरण

प्रमाणीकरण और सुरक्षा

हर अनुरोध को एक API key से प्रमाणित किया जाता है, जो इस header में भेजी जाती है X-API-Key हेडर में। कीज़ आपके टेनेंट एडमिन द्वारा बनाई जाती हैं, किसी भी समय रद्द की जा सकती हैं, और हर विशेषाधिकृत कॉल audit-logged होती है।

API की ••••••••

कीज़ केवल बनाते समय एक बार दिखाई जाती हैं और सिर्फ़ hash के रूप में संग्रहित होती हैं — कभी plaintext में नहीं।

  • API-की ऑथेंटिकेशन अपनी सीक्रेट key इसमें भेजें X-API-Key हेडर में, हर रिक्वेस्ट पर भेजें।
  • आपके एडमिन द्वारा बनाई और रद्द की जाती हैं Settings → API keys के अंतर्गत keys जनरेट और रद्द करें। किसी key को रद्द करना तुरंत प्रभावी होता है।
  • रेस्ट पर hashed हर की का सिर्फ़ एक अपरिवर्तनीय हैश स्टोर होता है — रॉ की सिर्फ़ एक बार, बनाते समय, दिखाई जाती है।
  • हर विशेषाधिकार-प्राप्त कॉल पर ऑडिट लॉगिंग कौन, कब, कहां से, क्या बदला — छेड़छाड़-प्रमाण और आपके टेनेंट एडमिन को दृश्य।
  • Scale टियर पर उपलब्ध प्रोग्रामेटिक API एक्सेस Scale के साथ शामिल है।
bash · एक रिक्वेस्ट प्रमाणित करें
curl https://api.servicesynchq.com/api/v1/customers \
  -H "X-API-Key: YOUR_API_KEY"

# 200 OK — returns your customers as JSON.
# Manage keys under Settings → API keys (admin only).
Webhooks · 12 इवेंट्स

हर इवेंट पर रियल-टाइम में प्रतिक्रिया दें

CRM, डिस्पैच, बिलिंग, पेमेंट, खरीद और ऑडिट के लाइफसाइकल इवेंट्स सब्सक्राइब करें। हर webhook क्रिप्टोग्राफ़िक रूप से साइन किया जाता है, exponential backoff के साथ रीट्राई होता है, और एक टिकाऊ retry-queue से समर्थित है।

job.created

नया जॉब बनाया गया।

job.completed

जॉब को पूरा के रूप में मार्क किया गया।

job.status_changed

एक जॉब नई स्थिति में पहुंचा।

invoice.created

नया इनवॉइस बनाया गया।

invoice.paid

इनवॉइस का भुगतान प्राप्त हुआ।

invoice.overdue

इनवॉइस बिना भुगतान अपनी देय तिथि पार कर गया।

payment.received

एक ग्राहक भुगतान दर्ज किया गया।

customer.created

नया कस्टमर जोड़ा गया।

estimate.sent

एस्टिमेट ग्राहक को भेजा गया।

estimate.accepted

ग्राहक ने एस्टिमेट स्वीकार किया।

estimate.rejected

कस्टमर ने एस्टिमेट अस्वीकार किया।

estimate.converted_to_job

स्वीकृत एस्टिमेट को जॉब में बदल दिया गया।

SDKs

क्लाइंट लाइब्रेरीज़ — रोडमैप पर

आधिकारिक SDKs विकसित हो रहे हैं। जब तक वे उपलब्ध नहीं होते, REST API ऊपर पूरी तरह प्रलेखित है और किसी भी HTTP क्लाइंट के साथ काम करता है।

Node.js

जल्द आ रहा है

Python

जल्द आ रहा है

PHP

जल्द आ रहा है

Ruby

जल्द आ रहा है
आइसोलेशन

टेनेंट आइसोलेशन, डेटाबेस स्तर पर लागू

हर रिक्वेस्ट स्वतः आपके वर्कस्पेस तक सीमित रहती है, वह भी डेटाबेस लेयर — सिर्फ़ एप्लिकेशन कोड में नहीं। एक वर्कस्पेस की क्वेरी वस्तुतः दूसरे वर्कस्पेस का डेटा पढ़ ही नहीं सकती — डेटाबेस स्वयं इसे लागू करता है।

  • ✓ आइसोलेशन database लेयर पर लागू
  • ✓ एक ऑटोमेटेड आइसोलेशन टेस्ट सूट द्वारा सत्यापित
  • ✓ क्रॉस-टेनेंट जॉइन प्रयास खाली लौटते हैं, कभी एरर नहीं
  • ✓ सुपर-एडमिन इम्पर्सनेशन audit-logged
Business C Fully isolated Business B Fully isolated Business A Fully isolated POSTGRES · ROW-LEVEL SECURITY POLICIES
रेट लिमिट्स

उदार, पारदर्शी — headers आपको बताते हैं

बर्स्ट क्षमता के साथ उचित-उपयोग रेट लिमिट। आपकी वर्तमान सीमा और बची हुई कोटा हर रिस्पॉन्स में लौटती है — X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset हेडर्स में (IETF ड्राफ्ट स्टैंडर्ड)। आपको कभी अनुमान नहीं लगाना पड़ेगा कि क्या अनुमत है।

स्टैंडर्ड

Solo · Essentials · Growth

API एक्सेस वाले हर प्लान में शामिल।

उदार डिफ़ॉल्ट्स

सामान्य इंटीग्रेशन के लिए पर्याप्त हेडरूम · हेडर्स आपको बताते हैं रियल-टाइम में

एंटरप्राइज़

Scale + Enterprise ऐड-ऑन

कस्टम सीमाएं, समर्पित क्षमता, SLAs।

कस्टम

सेल्स से संपर्क करें साइज़िंग के लिए

जब आप किसी लिमिट तक पहुंचते हैं: आपको एक HTTP मिलेगा 429 Too Many Requests के साथ एक Retry-After हेडर कुछ ही सेकंड में मिलेगा। हमारे SDKs इसे exponential backoff के साथ अपने-आप संभाल लेते हैं। अगर आपको नियमित रूप से और ऊंची सीमाएं चाहिए, हमसे बात करें — प्रकाशित संख्याएं न्यूनतम हैं, अधिकतम नहीं।
सुरक्षा

आपकी API keys, उनके सीक्रेट होने के अनुरूप सुरक्षित

हम आपकी कीज़ को उसी तरह सुरक्षित रखते हैं जैसे हम अपनी कीज़ को रखना चाहेंगे। यहां वह है जिस पर आप भरोसा कर सकते हैं।

हर जगह, सिर्फ़ TLS

API के हर अनुरोध को ट्रांज़िट में आधुनिक TLS से एन्क्रिप्ट किया जाता है। सादा HTTP एज पर ही अस्वीकार कर दिया जाता है।

डिज़ाइन से ही टेनेंट-स्कोप्ड

हर API की एक ही वर्कस्पेस से बंधी होती है। ऐसा कोई रास्ता नहीं जिससे वर्कस्पेस A की की, वर्कस्पेस B का डेटा पढ़ सके — यह डेटाबेस लेयर पर लागू होता है, सिर्फ़ एप्लिकेशन में नहीं।

हर विशेषाधिकार-प्राप्त कॉल पर ऑडिट लॉग

कौन, कब, कहां से, क्या बदला। छेड़छाड़-प्रमाण और टेनेंट-पठनीय। अनुपालन समीक्षा के लिए बिल्कुल सही। और पढ़ें सुरक्षा पेज

तत्काल की रद्दीकरण

लीक का शक है? एडमिन पैनल में की रद्द करें और यह तुरंत काम करना बंद कर देगी। एक नई की जारी करें और अपना इंटीग्रेशन अपडेट करें।

रेस्ट पर हैश्ड

प्रत्येक की का केवल एक अपरिवर्तनीय hash संग्रहित होता है। कच्ची की केवल एक बार, बनाते समय दिखाई जाती है, और कभी plaintext में संग्रहित नहीं होती।

हर कॉल पर ऑडिट ट्रेल

हर विशेषाधिकार-प्राप्त API क्रिया रिकॉर्ड की जाती है — कौन, कब, कहाँ से, क्या बदला — एक छेड़छाड़-स्पष्ट लॉग में जिसे आपके एडमिन समीक्षा कर सकते हैं।

आपकी API कीज़ की सुरक्षा के सर्वोत्तम तरीके

keys को कभी git में commit न करें एनवायरनमेंट वैरिएबल या किसी secrets manager का उपयोग करें। यदि कोई key लीक हो जाए, तो फ़िक्स पुश करने से पहले उसे हमारे एडमिन पैनल में रोटेट करें।
API को अपने बैकएंड से कॉल करें keys को सर्वर-साइड रखें — इन्हें ब्राउज़र या मोबाइल ऐप में कभी उजागर न करें।
तिमाही रूप से रोटेट करें या जब भी की-एक्सेस वाला कोई व्यक्ति आपकी टीम छोड़े।
हर इंटीग्रेशन के लिए एक की हर इंटीग्रेशन के लिए अलग key का मतलब है कि लीक होने पर आप सिर्फ़ एक को ही रद्द कर सकते हैं।
कीज़ को एक secrets manager में रखें एन्वायरनमेंट वेरिएबल्स या एक वॉल्ट — सोर्स कंट्रोल नहीं, कोई शेयर्ड डॉक नहीं।
ऑडिट लॉग पर नज़र रखें आपकी की का उपयोग करने वाला कोई अपरिचित IP जांच के योग्य संकेत है।

बनाने के लिए तैयार हैं?

API एक्सेस Scale टियर में शामिल है। पहले दस्तावेज़ पढ़ें, तैयार होने पर अपनी keys प्राप्त करें।