SyncHQ Pro
டெமோ பெறுங்கள் விற்பனை தொடர்புுங்கள் முன்கூட்டிய அணுகலைக் கோருங்கள் உள்நுழையவும்
REST API

சக்திவாய்ந்த ஒருங்கிணைப்புகளை உருவாக்குங்கள்.

ஒவ்வொரு விசைக்கும் தனித்தனி அங்கீகாரத்துடன் பாதுகாக்கப்பட்ட, பதிப்பிடப்பட்ட JSON REST API. வேலைகள், invoice-கள், பணம் செலுத்துதல்கள், மதிப்பீடுகள் மற்றும் வாடிக்கையாளர்கள் முழுவதும் உள்ள 12 நிகழ்வுகளுக்கான webhooks-ஐ சந்தா செய்யுங்கள். Scale திட்டத்தில் கிடைக்கிறது.

ஒவ்வொரு விசைக்கும் தனி அங்கீகாரம் பதிப்பிடப்பட்ட REST · v1 12 webhook நிகழ்வுகள் 5 அதிகார எல்லைகள்
ஆவணங்களைப் பார்க்கவும் API விசைகளைப் பெறுங்கள்
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 குறிப்பு

முக்கிய endpoints

பரப்பளவின் ஒரு சுவை. வாடிக்கையாளர்கள், பணிகள், விலைப்பட்டியல்கள், மதிப்பீடுகள், கட்டணங்கள், சரக்கு, திட்டமிடல் மற்றும் அறிவிப்புகள் அனைத்தும் JSON மூலம் முழு CRUD ஐ வெளிப்படுத்துகின்றன.

REST · /api/v1

JSON மீது முழு CRUD, பாதுகாப்பு உங்கள் X-API-Key.

/customers/jobs/estimates /invoices/payments/inventory
Webhooks · 12 நிகழ்வுகள்

ஒரு endpoint பதிவு செய்து, நிகழ்நேரத்தில் செயல்படுங்கள்.

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

இணைக்க இரண்டு வழிகள் — படிக்க/எழுத REST, நிகழ்நேரத் தள்ளலுக்கு webhooks.

200 OK GET

/api/v1/customers

அனைத்து வாடிக்கையாளர்களையும் பட்டியலிடுங்கள்.

cursor-அடிப்படையிலான பக்கப்படுத்தல்
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 ஆதரவுடன்

வாடிக்கையாளர்கள் · வேலைகள் · மதிப்பீடுகள் · invoice-கள் · பணம் செலுத்துதல்கள் · சரக்கு · கொள்முதல் · திட்டமிடல் · அறிவிப்புகள் முழுவதும் ஒரு பிரதிநிதி மாதிரி. ஒவ்வொரு சிறப்புரிமை அழைப்பும் audit-log செய்யப்படுகிறது. முழு reference-ஐப் பார்க்கவும் →

உலகளாவிய இணக்கம் · 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 returns
EU EU (SDI XML)இத்தாலிய SDI XML e-invoice வடிவம் · எல்லை தாண்டிய VAT வழிநடத்தல் · reverse-charge
SA KSA (ZATCA கட்டம் 1)இருமொழி அரபு/ஆங்கிலம் · 5 கட்டாய tags கொண்ட TLV QR குறியீடு · VAT 15%
AE UAE / GCCVAT 5% · அரபு விலைப்பட்டியல் ஆதரவு · FTA இணக்கப் புலங்கள்
CA கனடாGST · HST · PST · QST மாகாணம் வாரியான வழிநடத்தல் · CRA-தயார் விலைப்பட்டியல்கள்
AU ஆஸ்திரேலியா10% GST · ABN தடுப்பு 49% (ABN இல்லாத சப்ளையர்)
US அமெரிக்காமாநில விற்பனை வரி வழிநடத்தல் · destination/origin · மறுவிற்பனைச் சான்றிதழ் கையாளுதல்
வரி இயந்திரம்

இணக்கக் கணிதம், தானியங்கு முறையில்

நோக்கத்தை அனுப்புங்கள் — சரியான வரிப் பகுப்பை நாங்கள் கணக்கிடுகிறோம். மாநில மாற்றங்கள், பதிவு மாற்றங்கள், அதிகார எல்லை நிலைமாற்றங்கள் அனைத்தும் தரவு, குறியீடு அல்ல. வங்கி-தர தனிமைப்படுத்தல்: ஒவ்வொரு வாடிக்கையாளரின் தரவும் அதற்கே சொந்தமான தர்க்க vault-இல் இருக்கும் — vault-களுக்கு இடையே தரவைக் கலப்பதை ஆப் குறியீடு மட்டுமல்ல, தரவுத்தளமே மறுக்கிறது.

மாநிலத்திற்குள் vs மாநிலங்களுக்கிடையேயான வழிப்படுத்தல்

வாடிக்கையாளரின் மாநிலமும் விநியோகஸ்தரின் மாநிலமும் ஒன்றா? CGST + SGST. வேறுபட்டதா? IGST. கணக்கிடப்படுவது company.state vs customer.state.

இந்தியா GST IRN e-invoice

POST செய்யும்போது IRN + கையொப்பமிடப்பட்ட QR உருவாக்குகிறது. 24h cancellation window பிரத்யேக endpoint மூலம் வெளிப்படுத்தப்படுகிறது. HSN குறியீடுகள் தேடல் மூலம்.

UK CIS கழிவு

தானாகக் கழிக்கிறது 20% / 30% / 0% ஒப்பந்தக்காரர் பதிவு நிலையின் அடிப்படையில், ஒவ்வொரு துணை ஒப்பந்தக்காரருக்கும்.

KSA ZATCA TLV QR

Phase 1 இருமொழி விலைப்பட்டியல் + அனைத்து கட்டாயத் தகவல்களையும் encode செய்யும் TLV QR 5 mandatory tags. ரெண்டர் செய்வதற்கு முன் ZATCA உடன் சரிபார்க்கப்படுகிறது.

அங்கீகாரம்

அங்கீகாரம் & பாதுகாப்பு

ஒவ்வொரு கோரிக்கையும் ஒரு API விசை மூலம் அங்கீகரிக்கப்படுகிறது, அது X-API-Key header-இல். விசைகளை உங்கள் tenant நிர்வாகிகள் உருவாக்குகிறார்கள், எந்த நேரத்திலும் ரத்து செய்யலாம், மேலும் ஒவ்வொரு சிறப்புரிமை அழைப்பும் audit-log செய்யப்படுகிறது.

API விசை ••••••••

விசைகள் உருவாக்கப்படும்போது ஒருமுறை மட்டுமே காட்டப்படும், hash ஆக மட்டுமே சேமிக்கப்படும் — ஒருபோதும் plaintext-இல் அல்ல.

  • API-விசை அங்கீகாரம் உங்கள் ரகசிய விசையை இந்த X-API-Key ஒவ்வொரு கோரிக்கையிலும் header-இல்.
  • உங்கள் நிர்வாகிகளால் உருவாக்கப்பட்டு & ரத்து செய்யப்படும் அமைப்புகள் → API விசைகள் இன் கீழ் விசைகளை உருவாக்கவும் ரத்துசெய்யவும். ஒரு விசையை ரத்துசெய்தால் உடனடியாக அமலுக்கு வரும்.
  • சேமிப்பில் hash செய்யப்பட்டது ஒவ்வொரு விசையின் மீளமுடியாத hash மட்டுமே சேமிக்கப்படுகிறது — மூலவிசை உருவாக்கத்தின் போது ஒரேயொருமுறை மட்டும் காட்டப்படும்.
  • ஒவ்வொரு சிறப்புரிமை அழைப்பிலும் தணிக்கை பதிவு யார், எப்போது, எங்கிருந்து, என்ன மாற்றப்பட்டது — சேதப்படுத்தல் தெரியும்படி, உங்கள் tenant நிர்வாகிகளுக்குத் தெரியும்.
  • 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-ம் cryptographically கையொப்பமிடப்பட்டு, exponential backoff உடன் மீண்டும் முயற்சிக்கப்பட்டு, நீடித்த retry-queue-ஆல் ஆதரிக்கப்படுகிறது.

job.created

புதிய பணி உருவாக்கப்பட்டது.

job.completed

பணி முடிந்ததாகக் குறிக்கப்பட்டது.

job.status_changed

ஒரு வேலை புதிய நிலைக்கு நகர்ந்தது.

invoice.created

புதிய விலைப்பட்டியல் உருவாக்கப்பட்டது.

invoice.paid

விலைப்பட்டியல் கட்டணம் பெறப்பட்டது.

invoice.overdue

Invoice பணம் செலுத்தப்படாமல் அதன் நிலுவைத் தேதியைக் கடந்தது.

payment.received

ஒரு வாடிக்கையாளர் கட்டணம் பதிவு செய்யப்பட்டது.

customer.created

புதிய வாடிக்கையாளர் சேர்க்கப்பட்டார்.

estimate.sent

மதிப்பீடு வாடிக்கையாளருக்கு அனுப்பப்பட்டது.

estimate.accepted

வாடிக்கையாளர் மதிப்பீட்டை ஏற்றுக்கொண்டார்.

estimate.rejected

வாடிக்கையாளர் மதிப்பீட்டை நிராகரித்தார்.

estimate.converted_to_job

ஏற்கப்பட்ட மதிப்பீடு ஒரு வேலையாக மாற்றப்பட்டது.

SDKs

கிளையன்ட் லைப்ரரிகள் — திட்டவரைபடத்தில்

அதிகாரப்பூர்வ SDK-கள் உருவாக்கத்தில் உள்ளன. அவை வெளியாகும் வரை, REST API மேலே முழுமையாக ஆவணப்படுத்தப்பட்டுள்ளது, மேலும் எந்த HTTP client உடனும் வேலை செய்யும்.

Node.js

விரைவில் வருகிறது

Python

விரைவில் வருகிறது

PHP

விரைவில் வருகிறது

Ruby

விரைவில் வருகிறது
தனிமைப்படுத்தல்

குத்தகைதாரர் தனிமைப்படுத்தல், தரவுத்தளத்தில் அமல்படுத்தப்படுகிறது

ஒவ்வொரு கோரிக்கையும் தானாகவே உங்கள் பணியிடத்திற்கு எல்லைப்படுத்தப்படுகிறது — தரவுத்தள அடுக்கு — வெறும் பயன்பாட்டுக் குறியீட்டில் மட்டுமல்ல. ஒரு பணியிடத்திலிருந்து வரும் வினவல் மற்றொரு பணியிடத்தின் தரவை உண்மையிலேயே படிக்க முடியாது — தரவுத்தளமே அதை அமல்படுத்துகிறது.

  • ✓ தரவுத்தள அடுக்கில் தனிமைப்படுத்தல் அமல்படுத்தப்படுகிறது
  • ✓ தானியங்கி தனிமைப்படுத்தல் சோதனைத் தொகுப்பால் சரிபார்க்கப்பட்டது
  • ✓ குத்தகைதாரர்களுக்கிடையேயான join முயற்சிகள் காலியாகவே திரும்பும், ஒருபோதும் பிழையாகாது
  • ✓ Super-admin ஆள்மாறாட்டம் audit-log செய்யப்படுகிறது
Business C Fully isolated Business B Fully isolated Business A Fully isolated POSTGRES · ROW-LEVEL SECURITY POLICIES
வேக வரம்புகள்

தாராளம், வெளிப்படைத்தன்மை — headers உங்களுக்குச் சொல்கின்றன

burst கொள்திறனுடன் நியாயமான-பயன்பாட்டு விகித வரம்புகள். உங்கள் தற்போதைய வரம்பும் மீதமுள்ள ஒதுக்கீடும் ஒவ்வொரு பதிலிலும் திரும்பி வரும் X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset headers-இல் (IETF வரைவு தரநிலை). எது அனுமதிக்கப்படுகிறது என்பதை நீங்கள் ஒருபோதும் யூகிக்க வேண்டியதில்லை.

Standard

Solo · Essentials · Growth

API அணுகல் உள்ள ஒவ்வொரு திட்டத்திலும் சேர்க்கப்பட்டுள்ளது.

தாராளமான இயல்புநிலைகள்

சாதாரண ஒருங்கிணைப்புகளுக்குப் போதுமான இடம் · headers உங்களுக்குச் சொல்கின்றன நிகழ்நேரத்தில்

Pro

Scale திட்டம்

உற்பத்திச் சூழல் ஒருங்கிணைப்புகளுக்கு பன்மடங்கு கூடுதல் இடம்.

உயர்ந்த வரம்புகள்

அதிக அளவிலான ஒத்திசைவு, மொத்த ஏற்றுமதி, ETL பணிச்சுமைகளுக்கு

Enterprise

Scale + Enterprise add-on

தனிப்பயன் உச்சவரம்புகள், அர்ப்பணிக்கப்பட்ட கொள்திறன், SLA-கள்.

தனிப்பயன்

விற்பனையைத் தொடர்பு கொள்ளுங்கள் அளவை நிர்ணயிக்க

நீங்கள் ஒரு வரம்பை அடையும்போது: நீங்கள் ஒரு HTTP 429 Too Many Requests உடன், ஒரு Retry-After header சில நொடிகளில் கிடைக்கும். எங்கள் SDK-கள் இதை exponential backoff மூலம் தானாகக் கையாளும். உங்களுக்கு தொடர்ந்து அதிக வரம்புகள் தேவைப்பட்டால், எங்களிடம் பேசுங்கள் — வெளியிடப்பட்ட எண்கள் அடித்தளங்கள், உச்சவரம்புகள் அல்ல.
பாதுகாப்பு

உங்கள் API விசைகள், அவை உண்மையான ரகசியங்கள் — அப்படியே பாதுகாக்கப்படுகின்றன

எங்களுடையவை பாதுகாக்கப்பட வேண்டும் என்று நாங்கள் விரும்பும் விதத்திலேயே உங்கள் விசைகளையும் பாதுகாக்கிறோம். நீங்கள் நம்பியிருக்கக்கூடியவை இதோ.

எல்லா இடத்திலும் TLS மட்டுமே

API க்கான ஒவ்வொரு கோரிக்கையும் நவீன TLS உடன் பரிமாற்றத்தின்போது குறியாக்கம் செய்யப்படுகிறது. வெற்று HTTP விளிம்பிலேயே நிராகரிக்கப்படுகிறது.

வடிவமைப்பாலேயே Tenant-எல்லைப்படுத்தப்பட்டது

ஒவ்வொரு API விசையும் ஒரே ஒரு பணியிடத்துடன் பிணைக்கப்பட்டுள்ளது. பணியிடம் A-இன் விசை பணியிடம் B-இன் தரவைப் படிக்க எந்த வழியும் இல்லை — இது ஆப்பில் மட்டுமல்ல, தரவுத்தள அடுக்கில் அமல்படுத்தப்படுகிறது.

ஒவ்வொரு சிறப்புரிமை அழைப்பிலும் தணிக்கை பதிவு

யார், எப்போது, எங்கிருந்து, என்ன மாற்றப்பட்டது. சேதப்படுத்தல் தெரியும்படி, tenant படிக்கக்கூடியது. இணக்க மதிப்பாய்வுகளுக்குச் சரியானது. மேலும் படிக்க — பாதுகாப்புப் பக்கம்.

உடனடி விசை ரத்து

கசிவு சந்தேகமா? நிர்வாகப் பலகத்தில் விசையை ரத்து செய்யுங்கள் — உடனடியாக அது வேலை செய்வதை நிறுத்திவிடும். புதிய விசையை வழங்கி உங்கள் ஒருங்கிணைப்பைப் புதுப்பியுங்கள்.

ஓய்வில் ஹாஷ் செய்யப்பட்டது

ஒவ்வொரு விசையின் மாற்ற முடியாத hash மட்டுமே சேமிக்கப்படுகிறது. மூல விசை உருவாக்கத்தின்போது ஒருமுறை மட்டுமே காட்டப்படுகிறது, ஒருபோதும் plaintext-இல் சேமிக்கப்படுவதில்லை.

ஒவ்வொரு அழைப்பிலும் தணிக்கைத் தடம்

ஒவ்வொரு சிறப்புரிமை API செயலும் பதிவு செய்யப்படுகிறது — யார், எப்போது, எங்கிருந்து, என்ன மாறியது — உங்கள் நிர்வாகிகள் மதிப்பாய்வு செய்யக்கூடிய, சேதம் தெரியும் பதிவில்.

உங்கள் API விசைகளைப் பாதுகாக்க சிறந்த நடைமுறைகள்

விசைகளை ஒருபோதும் git-இல் commit செய்யாதீர்கள் சூழல் மாறிகள் அல்லது ஒரு secrets manager ஐப் பயன்படுத்துங்கள். ஒன்று கசிந்துவிட்டால், சரிசெய்தலைத் தள்ளுவதற்கு முன் எங்கள் நிர்வாகப் பலகத்தில் அதைச் சுழற்றுங்கள்.
உங்கள் backend-இலிருந்து API-ஐ அழைக்கவும் விசைகளை server பக்கத்திலேயே வைத்திருங்கள் — browser அல்லது mobile app-இல் ஒருபோதும் வெளிப்படுத்தாதீர்கள்.
காலாண்டுக்கு ஒருமுறை சுழற்றுங்கள் அல்லது விசை அணுகல் உள்ள யாராவது உங்கள் அணியை விட்டு வெளியேறும் எந்த நேரத்திலும்.
ஒவ்வொரு ஒருங்கிணைப்புக்கும் ஒரு விசை ஒவ்வொரு ஒருங்கிணைப்புக்கும் தனி விசை என்றால், ஒன்று கசிந்தால் அதை மட்டும் ரத்துசெய்யலாம்.
விசைகளை secrets manager-இல் சேமிக்கவும் Environment variables அல்லது ஒரு vault — source control அல்ல, பகிர்ந்த ஆவணமும் அல்ல.
தணிக்கை பதிவைக் கவனியுங்கள் உங்கள் விசையைப் பயன்படுத்தும் அறிமுகமில்லாத IP என்பது விசாரிக்கத் தகுந்த அறிகுறி.
வளங்கள்

நீங்கள் வெளியிடத் தேவையான அனைத்தும்

குறிப்பு ஆவணங்கள், changelog, மேலும் நீங்கள் சிக்கலில் இருக்கும்போது மறுமுனையில் உண்மையான மனிதர்.

📖

முழு API குறிப்பு

ஒவ்வொரு endpoint, ஒவ்வொரு parameter, ஒவ்வொரு பதில் வடிவம் — copy-paste செய்யக்கூடிய உதாரணங்களுடன்.

 📋

மாற்றப் பதிவு

பதிப்பிடப்பட்ட API வெளியீடுகள், நீக்க அறிவிப்புகள், மற்றும் இடம்பெயர்வு வழிகாட்டிகள்.

 💬

டெவலப்பர் ஆதரவு

பொறியியல் அணிக்கு நேரடித் தொடர்பு. Scale-இல் ஒரு வணிக நாளுக்குள் பதில்.

உருவாக்கத் தயாரா?

API அணுகல் Scale அடுக்கில் சேர்க்கப்பட்டுள்ளது. முதலில் ஆவணங்களைப் படியுங்கள், தயாராகும்போது உங்கள் விசைகளைப் பெறுங்கள்.

API விசைகளைப் பெறுங்கள் API ஆவணங்களைப் படியுங்கள்