REST API ya programu yako na nyaraka za API

Q: Kwa nini siwezi kuchapisha nukta ya mwisho?

Kwa Unda, Sasisha au Futa, washa kwanza kitendo hicho kwa jedwali husika kwenye Msimamizi. Programu ambayo hifadhidata yake ya mtandaoni inaendeshwa kwenye akaunti yako ya Cloudflare haiwezi kuchapisha nukta za mwisho kutoka MonstarX, kwa sababu hifadhidata iliyo hapa ina data ya majaribio ya hakikisho.

Kwa ufupiKwenye kichupo cha Msimamizi, APIs hugeuza majedwali ya programu yako kuwa nukta za mwisho za REST ambazo programu nyingine zinaweza kuziita — kuorodhesha, kupata, kuunda, kusasisha au kufuta rekodi. Unachagua jedwali, sehemu na nani anaruhusiwa kuiita (yeyote kwa kusoma, au wenye ufunguo wa API wa mradi pekee), kisha unaiwasha kwa Chapisha nukta ya mwisho. Unapotaka kuzishiriki, bofya Chapisha nyaraka ili kuweka mtandaoni ukurasa wa marejeleo ya API na faili ya OpenAPI kwa ajili ya wasanidi programu.

Wakati mwingine programu nyingine zinahitaji data ya programu yako: tovuti ya mshirika inayoorodhesha bidhaa zako, lahajedwali inayovuta oda mpya, programu ya simu, zana ya kuendesha kazi kiotomatiki kama Zapier au n8n. Zinawasiliana na programu yako kupitia API — seti ya anwani za wavuti (nukta za mwisho, kwa Kiingereza endpoints) zinazojibu kwa data badala ya kurasa. REST API ndiyo aina inayotumika zaidi.

MonstarX inakuundia moja bila msimbo. Unachagua unachotaka kushiriki, nayo inafanya kazi ndani ya sekunde chache, pamoja na ukurasa wa marejeleo ambao wasanidi programu wanaweza kuusoma.

Ninaipata wapi?

Fungua mradi wako, bofya Msimamizi kwenye upau wa juu, kisha APIs kwenye utepe wa Msimamizi. Unaona APIs za mradi: juu kuna upau wa Marejeleo ya API unaochapisha nyaraka zako za API; nukta zako za mwisho ziko upande wa kushoto, kila moja ikiwa na alama ya Inafanya kazi au Rasimu; na Funguo za API ziko chini yake.

Msimamizi, APIs za Jiko la Nyumbani: upau wa Marejeleo ya API wenye alama ya Imechapishwa na Nukta za mwisho zinazofanya kazi: 1, na nukta ya mwisho inayofanya kazi GET /recipes inayoitwa Orodha ya Mapishi pamoja na jina, njia, mkusanyiko na kitendo chake

Ninaundaje nukta ya mwisho?

Kwenye MsimamiziAPIs, bofya Nukta mpya ya mwisho (au + kando ya Nukta za mwisho).
Chagua Mkusanyiko — jedwali ambalo nukta ya mwisho inafanyia kazi, kama Mapishi.

Chagua Kitendo:

Kitendo	Mbinu na anwani	Kinachofanya
Orodha	`GET /recipes`	Hurudisha rekodi, ukurasa mmoja kwa wakati.
Pata	`GET /recipes/{id}`	Hurudisha rekodi moja kwa ID yake.
Unda	`POST /recipes`	Huongeza rekodi.
Sasisha	`PATCH /recipes/{id}`	Hubadilisha baadhi ya sehemu za rekodi.
Futa	`DELETE /recipes/{id}`	Huondoa rekodi.

Ipe Jina, Njia ya URL na, ukipenda, Maelezo. Haya yanaonekana kwenye nyaraka za API.
Chini ya Sehemu zilizowekwa wazi, weka alama kwenye sehemu hasa ambazo wanaoiita wanaruhusiwa kuona au kutuma. Chochote kisicho na alama kinabaki cha faragha. Sehemu zinazoonekana kuwa nyeti, kama manenosiri na tokeni, huachwa nje kila wakati.
Chini ya Ufikiaji, chagua nani anaweza kuiita (angalia hapa chini).
Weka alama kwenye Chapisha nukta ya mwisho na ubofye Hifadhi na uchapishe nukta ya mwisho. Nukta ya mwisho iliyochapishwa Inafanya kazi: inajibu maombi papo hapo. Ukiacha kisanduku bila alama, Hifadhi nukta ya mwisho huiweka kama Rasimu.

Kwenye orodha, kila nukta ya mwisho inasema Inafanya kazi au Rasimu. Neno hilohilo linaonekana chini ya Hariri nukta ya mwisho, likifuatwa na Mabadiliko ambayo hayajahifadhiwa hadi uhifadhi. Ondoa alama kwenye Chapisha nukta ya mwisho na uhifadhi ili kuiondoa mtandaoni bila kuifuta; Futa huiondoa kabisa.

Nani anaweza kuita nukta zangu za mwisho?

Ufikiaji	Nani anaweza kuiita	Inaruhusiwa kwa
Usomaji wa umma	Yeyote mwenye anwani.	Orodha na Pata pekee
Ufunguo wa API wa mradi	Wanaotuma mojawapo ya funguo za API za mradi wako pekee.	Kila kitendo

Nukta za mwisho zinazobadilisha data daima zinahitaji ufunguo.

Ninaundaje ufunguo wa API?

Kwenye MsimamiziAPIs, bofya Funguo za API.
Andika jina linaloonyesha ufunguo utatumika wapi, kama “Seva ya kidirisha cha mapishi”, kisha ubofye Unda ufunguo.
Nakili ufunguo papo hapo — unaanza na mxapi_ na hauwezi kuonyeshwa tena. Uhifadhi mahali salama, kama kidhibiti cha manenosiri au siri za huduma nyingine.

Funguo za API za mradi: jina la ufunguo limeandikwa na kitufe cha Unda ufunguo, pamoja na ujumbe kwamba funguo huruhusu kufikia kila nukta ya mwisho inayolindwa kwa ufunguo na kila ufunguo unaonyeshwa mara moja

Ufunguo mmoja hufungua kila nukta ya mwisho inayolindwa kwa ufunguo katika mradi, kwa hiyo ipe kila huduma ufunguo wake. Bofya Batilisha ili kuzima ufunguo; chochote kinachoutumia kinaacha kufanya kazi papo hapo.

Wanaoita hutuma ufunguo kwenye kichwa cha Authorization: Authorization: Bearer mxapi_….

Ninajaribuje nukta ya mwisho?

Fungua nukta ya mwisho na ubofye Jaribu. Weka ID ya rekodi, Ufunguo wa Bearer au Mwili wa ombi wa JSON ikiwa nukta ya mwisho inavihitaji, kisha ubofye Tuma ombi. Unaona hali (200 inamaanisha imefanikiwa), muda uliochukua na jibu. Kwa nukta ya mwisho inayohitaji ufunguo, bandika mojawapo ya funguo zako kutoka Funguo za API kwenye Ufunguo wa Bearer.

Majaribio huenda kwenye nukta ya mwisho halisi inayofanya kazi, kwa hiyo:

Rasimu haiwezi kujaribiwa bado. Kichupo cha Jaribu kinasema Nukta hii ya mwisho ni rasimu; bofya Hifadhi na uchapishe nukta ya mwisho hapo ili kuichapisha na kuijaribu.
Hifadhi mabadiliko yako kwanza. Kukiwa na mabadiliko ambayo hayajahifadhiwa, kichupo cha Jaribu kinakuomba uhifadhi kabla ya kujaribu, kikiwa na kitufe cha Hifadhi nukta ya mwisho.

Kichupo cha Jaribu cha GET /recipes: anwani kamili kwenye monstarx.com, kitufe cha Tuma ombi, na jibu la 200 linaloorodhesha mapishi kama JSON

Jaribio la Unda, Sasisha au Futa hubadilisha data yako halisi.

Kichupo cha Msimbo kina amri ya cURL iliyo tayari kunakiliwa, na faili ya OpenAPI JSON ambayo zana za API kama Postman na Insomnia zinaweza kuiingiza.

Kichupo cha Msimbo: amri ya cURL ya GET /recipes pamoja na kitufe cha Nakili, na kiungo cha faili ya OpenAPI JSON

Ninachapishaje na kushiriki nyaraka zangu za API?

Nyaraka zako za API ni ukurasa wa Marejeleo ya API kwa ajili ya wasanidi programu: kila nukta ya mwisho inayofanya kazi, sehemu zake, kama inahitaji ufunguo, kisanduku cha Ijaribu na mfano wa cURL. Kuchapisha nukta ya mwisho hakuchapishi nyaraka — wewe ndiye unayeamua wakati wa kuzishiriki.

Chapisha angalau nukta moja ya mwisho, na uhifadhi mabadiliko yoyote. Hadi hapo, upau wa Marejeleo ya API ulio juu ya MsimamiziAPIs unasema Haijachapishwa na kukuambia kinachokosekana.
Bofya Chapisha nyaraka.
Sasa upau unasema Imechapishwa. Bofya Nakili kiungo cha nyaraka ili kushiriki anwani, au Fungua nyaraka za API chini ya Funguo za API ili kuona ukurasa. Anwani inaonekana kama https://monstarx.com/api-docs/<your project id>.

Marejeleo ya API yaliyochapishwa ya Jiko la Nyumbani: jina na maelezo ya mradi, Nukta za mwisho: 1, ID ya mradi na anwani ya msingi, na GET /recipes yenye Usomaji wa umma, sehemu zake zilizowekwa wazi na kisanduku cha Ijaribu kilichorudisha mapishi kama JSON

Ukurasa unaanza na jina na maelezo ya mradi wako, idadi ya nukta za mwisho unazoorodhesha, ID ya mradi na anwani ya msingi. Yeyote mwenye kiungo anaweza kuusoma, na injini za utafutaji zinaelekezwa kutouweka kwenye faharasa. Unaonyesha nukta za mwisho zinazofanya kazi pekee na kamwe hauonyeshi funguo. OpenAPI JSON iliyo juu inaunganisha na maelezo yaleyale kama faili.

Ili kuondoa nyaraka mtandaoni, bofya Batilisha uchapishaji wa nyaraka: ukurasa na faili yake ya OpenAPI vinaacha kufanya kazi, huku nukta zako za mwisho zikiendelea kujibu. Ukiondoa mtandaoni nukta zote za mwisho, nyaraka nazo zinaondolewa, na unazichapisha tena ukiwa tayari.

Maombi na majibu yanaonekanaje?

Kila nukta ya mwisho iko chini ya https://monstarx.com/api/rest/<your project id>, ikifuatwa na njia yake.

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 ni rekodi 1 hadi 100 kwa kila ukurasa (25 usipoiweka) na page ni 1 hadi 100. hasMore husema kama kuna ukurasa mwingine.

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"}'

Jibu (hali 201) lina rekodi mpya chini ya data pamoja na id yake.

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'

Sasisha hujibu kwa rekodi iliyobadilishwa; Futa hujibu { "deleted": true }.

Kanuni za unachotuma:

Objekti ya JSON yenye Content-Type: application/json, hadi 64 KB.
Sehemu zilizowekwa wazi pekee, kila moja ikiwa thamani rahisi: maandishi (hadi vibambo 20,000), nambari, true/false au null.
ID haiwezi kuwekwa wala kubadilishwa, wala sehemu zinazoweza kusomwa tu kwenye Msimamizi.

Kitu kikiwa si sawa, jibu lina ujumbe wa error na hali: 400 (ombi si sahihi), 401 (ufunguo halali wa API wa mradi unahitajika), 403 (jedwali hilo au kitendo hicho hakiruhusiwi kwenye Msimamizi), 404 (hakuna nukta ya mwisho au rekodi kama hiyo), 409 (mgongano, kama nakala inayojirudia), 413 (jibu lingezidi 1 MB — weka wazi sehemu chache zaidi au tumia ukurasa mdogo zaidi).

Maswali ya kawaida

Kwa nini siwezi kubofya Chapisha nyaraka?

Nyaraka zinahitaji angalau nukta moja ya mwisho inayofanya kazi na kusiwe na mabadiliko ambayo hayajahifadhiwa. Weka alama kwenye Chapisha nukta ya mwisho kwenye nukta ya mwisho, bofya Hifadhi na uchapishe nukta ya mwisho, kisha Chapisha nyaraka.

Je, ni lazima nichapishe programu yangu ili API ifanye kazi?

Hapana. API husoma na kuandika hifadhidata ya mradi wako moja kwa moja, kwa hiyo inafanya kazi mara tu nukta ya mwisho inapochapishwa. Inatumia data ileile ya hakikisho lako na programu yako iliyo mtandaoni, na haihitaji uundaji, AI wala krediti.

Je, tovuti inaweza kuita API yangu kutoka kwenye kivinjari?

Ndiyo, tovuti yoyote inaweza kuita nukta zako za mwisho. Tumia nukta za mwisho za Usomaji wa umma kutoka kwenye kurasa za wavuti, na uweke miito inayolindwa kwa ufunguo kwenye seva ili ufunguo ubaki siri.

Nimepoteza ufunguo wa API. Je, ninaweza kuuona tena?

Hapana, ufunguo unaonyeshwa mara moja tu. Unda ufunguo mpya, ihamishe huduma itumie ufunguo huo, kisha Batilisha ule wa zamani.

Kwa nini siwezi kuchapisha nukta ya mwisho?

Kwa Unda, Sasisha au Futa, washa kwanza kitendo hicho kwa jedwali husika kwenye Msimamizi. Programu ambayo hifadhidata yake ya mtandaoni inaendeshwa kwenye akaunti yako ya Cloudflare haiwezi kuchapisha nukta za mwisho kutoka MonstarX, kwa sababu hifadhidata iliyo hapa ina data ya majaribio ya hakikisho.

Je, ninaweza kupata webhook data inapobadilika?

Si kutoka Msimamizi → APIs, ambayo hujibu maombi. Iombe MonstarX iongeze webhook kwenye programu yako — kwa mfano “oda inapowekwa, itume kwa POST kwenye anwani hii”.

Angalia pia

Paneli ya msimamizi ya programu yakoMahali APIs zilipo, pamoja na majedwali, watumiaji na shughuli zako.

Hifadhidata ya programu yakoMajedwali ambayo nukta zako za mwisho husoma na kuandika.

Siri na funguo za APIFunguo ambazo programu yako hutumia kwa huduma nyingine.

Tumia MonstarX kutoka kwa wakala wako wa kuandika msimboEndesha MonstarX yenyewe kutoka Claude Code, Cursor na mawakala wengine.