உங்கள் செயலியின் REST API-யும் API ஆவணங்களும்

சில நேரங்களில் பிற மென்பொருள்களுக்கு உங்கள் செயலியின் தரவு தேவைப்படும்: உங்கள் பொருட்களைப் பட்டியலிடும் ஒரு கூட்டாளியின் இணையதளம், புதிய ஆர்டர்களை இழுத்துக்கொள்ளும் விரிதாள், ஒரு மொபைல் செயலி, Zapier அல்லது n8n போன்ற தானியக்கக் கருவி. அவை ஒரு API வழியாக உங்கள் செயலியுடன் பேசுகின்றன. API என்பது பக்கங்களுக்குப் பதிலாகத் தரவைத் தரும் இணைய முகவரிகளின் (எண்ட்பாயிண்ட்கள்) தொகுப்பு. அவற்றில் மிகப் பொதுவான வகை REST API.

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

இது எங்கே இருக்கிறது?

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

எண்ட்பாயிண்ட்டை உருவாக்குவது எப்படி?

1. நிர்வாகி›API-கள் பகுதியில், புதிய எண்ட்பாயிண்ட் என்பதைக் கிளிக் செய்யுங்கள் (அல்லது எண்ட்பாயிண்ட்கள் அருகே உள்ள + பொத்தானை).

2. தரவுத் தொகுப்பு என்பதைத் தேர்ந்தெடுங்கள். அதாவது, எண்ட்பாயிண்ட் வேலை செய்யும் அட்டவணை; உதாரணமாக, சமையல் குறிப்புகள் அட்டவணை.

3. செயல்பாடு என்பதைத் தேர்ந்தெடுங்கள்:

   செயல்பாடு	முறையும் முகவரியும்	அது செய்வது
   பட்டியலிடு	GET /recipes	பதிவுகளை ஒரு நேரத்தில் ஒரு பக்கமாகத் தரும்.
   பெறு	GET /recipes/{id}	ஒரு பதிவை அதன் id மூலம் தரும்.
   உருவாக்கு	POST /recipes	ஒரு பதிவைச் சேர்க்கும்.
   புதுப்பி	PATCH /recipes/{id}	ஒரு பதிவின் சில புலங்களை மாற்றும்.
   நீக்கு	DELETE /recipes/{id}	ஒரு பதிவை அகற்றும்.

4. அதற்கு ஒரு பெயர், ஒரு URL பாதை, விரும்பினால் ஒரு விளக்கம் கொடுங்கள். இவை API ஆவணங்களில் தெரியும்.

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

6. அணுகல் என்பதன் கீழ், யார் அழைக்கலாம் என்று தேர்ந்தெடுங்கள் (கீழே பாருங்கள்).

7. எண்ட்பாயிண்ட்டை வெளியிடு என்பதைத் தேர்வுசெய்து, எண்ட்பாயிண்ட்டைச் சேமித்து வெளியிடு என்பதைக் கிளிக் செய்யுங்கள். வெளியிட்ட எண்ட்பாயிண்ட் இயங்குகிறது: அது உடனே கோரிக்கைகளுக்குப் பதில் தரும். பெட்டியைத் தேர்வுசெய்யாமல் விட்டால், எண்ட்பாயிண்ட்டைச் சேமி அதை வரைவு ஆக வைத்திருக்கும்.

   

பட்டியலில், ஒவ்வொரு எண்ட்பாயிண்ட்டும் இயங்குகிறது அல்லது வரைவு எனக் காட்டும். அதே சொல் எண்ட்பாயிண்ட்டைத் திருத்து என்பதன் கீழும் தெரியும்; நீங்கள் சேமிக்கும் வரை அதைத் தொடர்ந்து சேமிக்கப்படாத மாற்றங்கள் என்றும் தெரியும். ஓர் எண்ட்பாயிண்ட்டை நீக்காமல் நிறுத்த, எண்ட்பாயிண்ட்டை வெளியிடு தேர்வை நீக்கிச் சேமியுங்கள்; நீக்கு அதை அகற்றும்.

குறிப்பு

உருவாக்கு, புதுப்பி, நீக்கு ஆகியவை உங்கள் உண்மையான தரவை மாற்றும். இவற்றில் ஒன்றை வெளியிடுவதற்கு முன், நிர்வாகி தாவலில் அந்த அட்டவணைக்கான அமைப்புகளில் அந்தச் செயலை (சேர்த்தல், திருத்துதல் அல்லது நீக்குதல்) இயக்குங்கள். உங்கள் செயலியின் நிர்வாகி பகுதி பக்கத்தைப் பாருங்கள்.

என் எண்ட்பாயிண்ட்களை யார் அழைக்கலாம்?

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

தரவை மாற்றும் எண்ட்பாயிண்ட்களுக்கு எப்போதும் விசை தேவை.

API விசையை உருவாக்குவது எப்படி?

1. நிர்வாகி›API-கள் பகுதியில், API விசைகள் என்பதைக் கிளிக் செய்யுங்கள்.

2. விசை எங்கே பயன்படும் என்று சொல்லும் ஒரு பெயரைத் தட்டச்சு செய்யுங்கள் (உதாரணமாக “சமையல் குறிப்பு விட்ஜெட் சேவையகம்”). பிறகு விசையை உருவாக்கு என்பதைக் கிளிக் செய்யுங்கள்.

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

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

அழைப்பவர்கள் விசையை Authorization ஹெடரில் அனுப்புவார்கள்: Authorization: Bearer mxapi_….

எச்சரிக்கை

API விசைகளை ஒரு சேவையகத்தில் மட்டுமே வையுங்கள். இணையப் பக்கத்திலோ மொபைல் செயலியிலோ வைத்த விசையைப் பார்க்கும் எவரும் படித்துவிடலாம்.

எண்ட்பாயிண்ட்டைச் சோதிப்பது எப்படி?

எண்ட்பாயிண்ட்டைத் திறந்து சோதனை என்பதைக் கிளிக் செய்யுங்கள். எண்ட்பாயிண்ட்டுக்குத் தேவையென்றால் பதிவு ID, Bearer விசை அல்லது JSON உள்ளடக்கம் என்பதை உள்ளிட்டு, கோரிக்கையை அனுப்பு என்பதைக் கிளிக் செய்யுங்கள். நிலை (200 என்றால் வேலை செய்தது), எவ்வளவு நேரம் ஆனது, பதில் ஆகியவை தெரியும். விசை தேவைப்படும் எண்ட்பாயிண்ட்டுக்கு, API விசைகள் பகுதியில் உள்ள உங்கள் விசைகளில் ஒன்றை Bearer விசை என்பதில் ஒட்டுங்கள்.

சோதனைகள் உண்மையான, இயங்கும் எண்ட்பாயிண்ட்டுக்கே போகும். அதனால்:

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

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

குறியீடு தாவலில் நகலெடுக்கத் தயாரான cURL கட்டளையும், Postman, Insomnia போன்ற API கருவிகள் இறக்குமதி செய்யக்கூடிய OpenAPI JSON கோப்பும் உள்ளன.

என் API ஆவணங்களை வெளியிட்டுப் பகிர்வது எப்படி?

உங்கள் API ஆவணங்கள் என்பது டெவலப்பர்களுக்கான ஒரு API குறிப்பு பக்கம்: இயங்கும் ஒவ்வொரு எண்ட்பாயிண்ட்டும், அதன் புலங்களும், அதற்கு விசை தேவையா என்பதும், ஒரு முயற்சி செய்து பார் பெட்டியும், ஒரு cURL உதாரணமும். ஓர் எண்ட்பாயிண்ட்டை வெளியிட்டால் ஆவணங்கள் வெளியாகாது; அவற்றை எப்போது பகிர்வது என்று நீங்களே தேர்ந்தெடுக்கலாம்.

1. குறைந்தது ஓர் எண்ட்பாயிண்ட்டை வெளியிட்டு, மாற்றங்கள் இருந்தால் சேமியுங்கள். அதுவரை நிர்வாகி›API-கள் பகுதியின் மேலே உள்ள API குறிப்பு பட்டை வெளியிடப்படவில்லை எனக் காட்டி, என்ன குறைகிறது என்றும் சொல்லும்.

2. ஆவணங்களை வெளியிடு என்பதைக் கிளிக் செய்யுங்கள்.

   

3. இப்போது பட்டை வெளியிடப்பட்டது எனக் காட்டும். முகவரியைப் பகிர ஆவண இணைப்பை நகலெடு என்பதைக் கிளிக் செய்யுங்கள்; பக்கத்தைப் பார்க்க API விசைகள் என்பதன் கீழ் உள்ள API ஆவணத்தைத் திற என்பதைக் கிளிக் செய்யுங்கள். முகவரி https://monstarx.com/api-docs/<your project id> போல இருக்கும்.

monstarx.com

பக்கத்தின் தொடக்கத்தில் உங்கள் திட்டத்தின் பெயரும் விளக்கமும், அது எத்தனை எண்ட்பாயிண்ட்களைப் பட்டியலிடுகிறது என்பதும், திட்டத்தின் ID-யும், அடிப்படை முகவரியும் இருக்கும். இணைப்பு உள்ள எவரும் அதைப் படிக்கலாம்; அதைத் தேடல் குறியீட்டில் சேர்க்க வேண்டாம் என்று தேடுபொறிகளுக்குச் சொல்லப்படும். அது இயங்கும் எண்ட்பாயிண்ட்களை மட்டுமே காட்டும்; விசைகளை ஒருபோதும் காட்டாது. மேலே உள்ள OpenAPI JSON அதே விளக்கத்தை ஒரு கோப்பாகத் தரும்.

ஆவணங்களை அகற்ற ஆவணங்களின் வெளியீட்டை நிறுத்து என்பதைக் கிளிக் செய்யுங்கள்: பக்கமும் அதன் OpenAPI கோப்பும் வேலை செய்வதை நிறுத்தும்; உங்கள் எண்ட்பாயிண்ட்கள் தொடர்ந்து பதில் தரும். எல்லா எண்ட்பாயிண்ட்களையும் நிறுத்தினால், ஆவணங்களின் வெளியீடும் நிற்கும்; நீங்கள் தயாரானதும் அவற்றை மீண்டும் வெளியிடலாம்.

கோரிக்கைகளும் பதில்களும் எப்படி இருக்கும்?

ஒவ்வொரு எண்ட்பாயிண்ட்டும் https://monstarx.com/api/rest/<your project id> என்பதன் கீழ், அதைத் தொடர்ந்து அதன் பாதையுடன் இருக்கும்.

பட்டியலிடு

curl 'https://monstarx.com/api/rest/<project id>/recipes?page=1&limit=25'

{
  "data": [
    { "id": "41a6…", "title": "Street tacos al pastor", "country_code": "MX" }
  ],
  "page": 1,
  "limit": 25,
  "hasMore": false
}

limit என்பது ஒரு பக்கத்துக்கு 1 முதல் 100 பதிவுகள் (குறிப்பிடாவிட்டால் 25); page என்பது 1 முதல் 100. இன்னொரு பக்கம் உள்ளதா என்று hasMore சொல்லும்.

உருவாக்கு

curl -X POST 'https://monstarx.com/api/rest/<project id>/recipes' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Lemon ricotta pancakes", "country_code": "IT"}'

பதிலில் (நிலை 201) புதிய பதிவு data என்பதன் கீழ் அதன் id-உடன் இருக்கும்.

புதுப்பித்தலும் நீக்குதலும்

curl -X PATCH 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Fluffy lemon ricotta pancakes"}'

curl -X DELETE 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY'

புதுப்பி மாற்றிய பதிவைப் பதிலாகத் தரும்; நீக்கு { "deleted": true } எனப் பதில் தரும்.

நீங்கள் அனுப்புவதற்கான விதிகள்:

• Content-Type: application/json-உடன் ஒரு JSON ஆப்ஜெக்ட், அதிகபட்சம் 64 KB.
• வெளிப்படுத்தப்படும் புலங்கள் மட்டும், ஒவ்வொன்றும் ஓர் எளிய மதிப்பாக: உரை (அதிகபட்சம் 20,000 எழுத்துகள்), ஓர் எண், true/false அல்லது null.
• id-ஐ அமைக்கவோ மாற்றவோ முடியாது; நிர்வாகி பகுதியில் படிக்க மட்டுமே உள்ள புலங்களையும் மாற்ற முடியாது.

ஏதாவது தவறாக இருந்தால், பதிலில் ஒரு error செய்தியும் ஒரு நிலையும் இருக்கும்: 400 (கோரிக்கை சரியில்லை), 401 (சரியான திட்ட API விசை தேவை), 403 (அந்த அட்டவணை அல்லது செயல் நிர்வாகி பகுதியில் அனுமதிக்கப்படவில்லை), 404 (அப்படி ஓர் எண்ட்பாயிண்ட்டோ பதிவோ இல்லை), 409 (நகல் போன்ற முரண்பாடு), 413 (பதில் 1 MB-ஐத் தாண்டும் — குறைவான புலங்களை வெளிப்படுத்துங்கள் அல்லது சிறிய பக்கத்தைப் பயன்படுத்துங்கள்).

அடிக்கடி கேட்கப்படும் கேள்விகள்

“ஆவணங்களை வெளியிடு” என்பதை ஏன் கிளிக் செய்ய முடியவில்லை?

ஆவணங்களுக்குக் குறைந்தது ஓர் இயங்கும் எண்ட்பாயிண்ட் தேவை; சேமிக்காத மாற்றங்களும் இருக்கக்கூடாது. ஓர் எண்ட்பாயிண்ட்டில் எண்ட்பாயிண்ட்டை வெளியிடு என்பதைத் தேர்வுசெய்து, எண்ட்பாயிண்ட்டைச் சேமித்து வெளியிடு என்பதைக் கிளிக் செய்யுங்கள்; பிறகு ஆவணங்களை வெளியிடு.

API வேலை செய்ய என் செயலியை வெளியிட வேண்டுமா?

தேவையில்லை. API உங்கள் திட்டத்தின் தரவுத்தளத்தை நேரடியாகப் படிக்கும், எழுதும். அதனால் ஓர் எண்ட்பாயிண்ட் வெளியிடப்பட்டதுமே அது வேலை செய்யும். உங்கள் முன்னோட்டமும் இயங்கும் செயலியும் பயன்படுத்தும் அதே தரவை இதுவும் பயன்படுத்தும்; உருவாக்கமோ, AI-யோ, கிரெடிட்களோ தேவையில்லை.

ஓர் இணையதளம் உலாவியிலிருந்து என் API-ஐ அழைக்க முடியுமா?

ஆம், எந்த இணையதளமும் உங்கள் எண்ட்பாயிண்ட்களை அழைக்கலாம். இணையப் பக்கங்களிலிருந்து அனைவரும் படிக்கலாம் எண்ட்பாயிண்ட்களைப் பயன்படுத்துங்கள். விசை ரகசியமாக இருக்க, விசையால் பாதுகாக்கப்பட்ட அழைப்புகளை ஒரு சேவையகத்திலேயே வையுங்கள்.

ஒரு API விசையைத் தொலைத்துவிட்டேன். அதை மீண்டும் பார்க்கலாமா?

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

ஓர் எண்ட்பாயிண்ட்டை ஏன் வெளியிட முடியவில்லை?

உருவாக்கு, புதுப்பி அல்லது நீக்கு என்றால், முதலில் நிர்வாகி பகுதியில் அந்த அட்டவணைக்கு அந்தச் செயலை இயக்குங்கள். இயங்கும் தரவுத்தளம் உங்கள் சொந்த Cloudflare கணக்கில் இயங்கும் செயலி, MonstarX-இலிருந்து எண்ட்பாயிண்ட்களை வெளியிட முடியாது; ஏனெனில் இங்குள்ள தரவுத்தளத்தில் முன்னோட்டத்தின் பயிற்சித் தரவு மட்டுமே உள்ளது.

தரவு மாறும்போது webhook-கள் கிடைக்குமா?

நிர்வாகி → API-கள் பகுதியிலிருந்து கிடைக்காது; அது கோரிக்கைகளுக்குப் பதில் மட்டுமே தரும். உங்கள் செயலியில் ஒரு webhook-ஐச் சேர்க்கும்படி MonstarX-இடம் கேளுங்கள்; உதாரணமாக “ஓர் ஆர்டர் வந்ததும், அதை இந்த முகவரிக்கு POST செய்”.

தொடர்புடையவை

உங்கள் செயலியின் நிர்வாகி பகுதிஉங்கள் அட்டவணைகள், பயனர்கள், செயல்பாடுகளுடன் API-களும் இருக்கும் இடம்.

உங்கள் செயலியின் தரவுத்தளம்உங்கள் எண்ட்பாயிண்ட்கள் படிக்கும், எழுதும் அட்டவணைகள்.

ரகசியங்களும் API விசைகளும்பிற சேவைகளுக்காக உங்கள் செயலி பயன்படுத்தும் விசைகள்.

உங்கள் குறியீடு எழுதும் முகவரிலிருந்து MonstarXClaude Code, Cursor போன்றவற்றிலிருந்து MonstarX-ஐயே இயக்குங்கள்.