REST API na manhajarku da takardun API

Wani lokaci wasu manhajoji suna buƙatar bayanan manhajarku: gidan yanar gizon abokin hulɗa da ke jera kayayyakinku, takardar lissafi da ke jawo sababbin oda, manhajar waya, kayan aikin sarrafa kai kamar Zapier ko n8n. Suna magana da manhajarku ta API — tarin adireshin yanar gizo (tashoshin API, endpoints) da ke amsawa da bayanai a maimakon shafuka. REST API shi ne nau’in da aka fi amfani da shi.

MonstarX yana yi muku ɗaya ba tare da lambar tushe ba. Kuna zaɓar abin da za a raba, sai ya fara aiki cikin daƙiƙoƙi, tare da shafin bayanai da masu haɓaka manhaja za su iya karantawa.

A ina zan same shi?

Ku buɗe aikinku, ku danna Gudanarwa a sandar sama, sai APIs a gefen Gudanarwa. Za ku ga APIs na aikin: a sama, sandar Bayanan API da ke wallafa takardun API ɗinku; tashoshin API ɗinku a hagu, kowanne da alamar Yana kan intanet ko Daftari; da Maɓallan API a ƙarƙashinsu.

Ta yaya zan ƙirƙiri tashar API?

1. A Gudanarwa›APIs, ku danna Sabuwar tashar API (ko + kusa da Tashoshin API).

2. Ku zaɓi Tarin bayanai — jadawalin da tashar take aiki a kansa, kamar Recipes.

3. Ku zaɓi Nau’in buƙata:

   Nau’in buƙata	Hanya da adireshi	Abin da yake yi
   Jera	GET /recipes	Yana dawo da bayanai, shafi ɗaya a lokaci ɗaya.
   Samu	GET /recipes/{id}	Yana dawo da bayani ɗaya ta ID ɗinsa.
   Ƙirƙira	POST /recipes	Yana ƙara bayani.
   Sabunta	PATCH /recipes/{id}	Yana canja wasu filayen bayani.
   Goge	DELETE /recipes/{id}	Yana cire bayani.

4. Ku ba ta Suna, Hanyar URL kuma, idan kuna so, Bayani. Suna bayyana a takardun API.

5. A ƙarƙashin Filayen da ake nunawa, ku sa alama a ainihin filayen da masu kira za su iya gani ko aikawa. Duk abin da ba a sa wa alama ba yana zama a sirri. Filayen da suke kama da na sirri, kamar kalmomin sirri da token, ana cire su kullum.

6. A ƙarƙashin Izinin kira, ku zaɓi wanda zai iya kiran ta (duba ƙasa).

7. Ku sa alama a Wallafa tashar API sannan ku danna Ajiye da wallafa tashar API. Tashar da aka wallafa tana da matsayin Yana kan intanet: tana amsa buƙatu nan take. Idan kuka bar akwatin ba tare da alama ba, Ajiye tashar API yana riƙe ta a matsayin Daftari.

   

A jerin, kowace tasha tana cewa Yana kan intanet ko Daftari. Kalma ɗaya tana bayyana a ƙarƙashin Gyara tashar API, sannan Canje-canjen da ba a ajiye su ba har sai kun ajiye. Ku cire alamar Wallafa tashar API ku ajiye don cire ta daga aiki ba tare da goge ta ba; Goge yana cire ta gaba ɗaya.

Lura

Ƙirƙira, Sabunta da Goge suna canja bayananku na gaske. Kafin ku iya wallafa ɗaya, ku kunna wannan aikin (ƙarawa, gyarawa ko gogewa) ga jadawalin a saitunansa na shafin Gudanarwa. Duba Gudanarwa ta manhajarku.

Wa zai iya kiran tashoshin API ɗina?

Izinin kira	Wa zai iya kiran ta	An yarda da shi ga
Karatu ga kowa	Duk wanda ke da adireshin.	Jera da Samu kawai
Maɓallin API na aikin	Masu kira da ke aika ɗaya daga cikin maɓallan API na aikinku kawai.	Kowane nau’in buƙata

Tashoshin da ke canja bayanai kullum suna buƙatar maɓalli.

Ta yaya zan ƙirƙiri maɓallin API?

1. A Gudanarwa›APIs, ku danna Maɓallan API.

2. Ku rubuta sunan da ke faɗin inda za a yi amfani da maɓallin, kamar “Sabar widget na girke-girke”, sannan ku danna Ƙirƙiri maɓalli.

3. Ku kwafi maɓallin nan take — yana farawa da mxapi_ kuma ba za a iya sake nuna shi ba. Ku ajiye shi a wuri mai aminci, kamar manajan kalmomin sirri ko wurin bayanan sirri na ɗayan sabis ɗin.

Maɓalli ɗaya yana buɗe kowace tashar API mai kariyar maɓalli a aikin, don haka ku ba kowane sabis maɓallinsa. Ku danna Soke don kashe maɓalli; duk abin da ke amfani da shi yana daina aiki nan take.

Masu kira suna aika maɓallin a kanun Authorization: Authorization: Bearer mxapi_….

Hattara

Ku ajiye maɓallan API a sabar. Maɓallin da aka saka a shafin yanar gizo ko manhajar waya kowa zai iya karanta shi idan ya duba.

Ta yaya zan gwada tashar API?

Ku buɗe tashar sannan ku danna Gwaji. Ku shigar da ID na rikodi, Maɓallin Bearer ko Bayanin buƙata na JSON idan tashar tana buƙatarsu, sannan ku danna Aika buƙata. Za ku ga matsayin (200 yana nufin ya yi nasara), tsawon lokacin da ya ɗauka da amsar. Don tashar da ke buƙatar maɓalli, ku manna ɗaya daga cikin maɓallanku daga Maɓallan API a Maɓallin Bearer.

Gwaje-gwaje suna zuwa ainihin tashar da ke aiki, don haka:

• Ba za a iya gwada daftari ba tukuna. Shafin Gwaji yana cewa Wannan tashar API daftari ce; ku danna Ajiye da wallafa tashar API a can don wallafa ta ku gwada ta.
• Ku fara ajiye canje-canjenku. Idan akwai canje-canjen da ba a ajiye ba, shafin Gwaji yana neman ku ajiye kafin gwaji, tare da maɓallin Ajiye tashar API.

Gwajin Ƙirƙira, Sabunta ko Goge yana canja bayananku na gaske.

Shafin Lambar tushe yana da umarnin cURL a shirye don kwafa, da fayil ɗin OpenAPI JSON da kayan aikin API kamar Postman da Insomnia za su iya shigo da shi.

Ta yaya zan wallafa in raba takardun API ɗina?

Takardun API ɗinku shafin Bayanan API ne ga masu haɓaka manhaja: kowace tasha mai aiki, filayenta, ko tana buƙatar maɓalli, akwatin Gwada shi da misalin cURL. Wallafa tashar API ba ya wallafa takardun — ku ne kuke zaɓar lokacin raba su.

1. Ku wallafa aƙalla tashar API ɗaya, kuma ku ajiye duk wani canji. Kafin haka, sandar Bayanan API a saman Gudanarwa›APIs tana cewa Ba a wallafa ba kuma tana faɗa muku abin da ya rage.

2. Ku danna Wallafa takardu.

   

3. Yanzu sandar tana cewa An wallafa. Ku danna Kwafa hanyar haɗin takardun don raba adireshin, ko Buɗe takardun API a ƙarƙashin Maɓallan API don ganin shafin. Adireshin yana kama da https://monstarx.com/api-docs/<your project id>.

monstarx.com

Shafin yana buɗewa da sunan aikinku da bayaninsa, yawan tashoshin API da yake jerawa, ID na aikin da adireshin tushe. Duk wanda ke da hanyar haɗin zai iya karanta shi, kuma ana gaya wa injunan bincike kada su saka shi a sakamakonsu. Yana nuna tashoshin da ke aiki ne kawai kuma ba ya taɓa nuna maɓallai. OpenAPI JSON a sama yana haɗawa da bayani iri ɗaya a matsayin fayil.

Don cire takardun, ku danna Janye wallafar takardu: shafin da fayil ɗinsa na OpenAPI suna daina aiki, amma tashoshin API ɗinku suna ci gaba da amsawa. Idan kuka cire dukan tashoshin daga aiki, takardun ma ana janye su, kuma za ku sake wallafa su idan kun shirya.

Yaya buƙatu da amsoshi suke kama?

Kowace tasha tana ƙarƙashin https://monstarx.com/api/rest/<your project id>, sannan hanyarta.

Jera

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 yana daga bayanai 1 zuwa 100 a kowane shafi (25 idan ba ku saka shi ba), page kuma daga 1 zuwa 100. hasMore yana faɗin ko akwai wani shafi.

Ƙirƙira

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

Amsar (matsayi 201) tana da sabon bayanin a ƙarƙashin data da id ɗinsa.

Sabunta da gogewa

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'

Sabunta yana amsawa da bayanin da aka canja; Goge yana amsawa da { "deleted": true }.

Ƙa’idojin abin da kuke aikawa:

• Abin JSON tare da Content-Type: application/json, har 64 KB.
• Filayen da ake nunawa kawai, kowanne ƙima mai sauƙi: rubutu (har haruffa 20,000), lamba, true/false ko null.
• Ba za a iya saita ko canja ID ba, haka ma filayen da ke karantawa kawai a Gudanarwa.

Idan wani abu bai yi daidai ba, amsar tana da saƙon error da matsayi: 400 (buƙatar ba ta yi daidai ba), 401 (ana buƙatar ingantaccen maɓallin API na aikin), 403 (ba a yarda da wannan jadawalin ko aikin a Gudanarwa ba), 404 (babu irin wannan tasha ko bayani), 409 (rikici, kamar kwafi biyu), 413 (amsar za ta wuce 1 MB — ku nuna filaye kaɗan ko ku yi amfani da ƙaramin shafi).

Tambayoyin da ake yawan yi

Me ya sa ba zan iya danna Wallafa takardu ba?

Takardun suna buƙatar aƙalla tashar API ɗaya mai aiki kuma babu canje-canjen da ba a ajiye ba. Ku sa alama a Wallafa tashar API a wata tasha, ku danna Ajiye da wallafa tashar API, sannan Wallafa takardu.

Sai na wallafa manhajata kafin API ya yi aiki?

A’a. API yana karantawa da rubutawa a rumbun bayanan aikinku kai tsaye, don haka yana aiki da zarar an wallafa tashar API. Yana amfani da bayanai iri ɗaya da samfotinku da manhajarku da ke kan intanet, kuma ba ya buƙatar gini, AI ko kiredit.

Gidan yanar gizo zai iya kiran API ɗina daga burauza?

Ƙwarai, kowane gidan yanar gizo zai iya kiran tashoshin API ɗinku. Ku yi amfani da tashoshin Karatu ga kowa daga shafukan yanar gizo, kuma ku ajiye kiran da ke buƙatar maɓalli a sabar don maɓallin ya zauna a sirri.

Na rasa maɓallin API. Zan iya sake ganin sa?

A’a, ana nuna maɓalli sau ɗaya kawai. Ku ƙirƙiri sabon maɓalli, ku sauya sabis ɗin zuwa gare shi, sannan ku danna Soke a kan tsohon.

Me ya sa ba zan iya wallafa tashar API ba?

Don Ƙirƙira, Sabunta ko Goge, ku fara kunna wannan aikin ga jadawalin a Gudanarwa. Manhajar da rumbun bayananta na intanet yake aiki a asusunku na Cloudflare ba za ta iya wallafa tashoshin API daga MonstarX ba, domin rumbun bayanan da ke nan yana riƙe bayanan gwaji na samfoti.

Zan iya samun webhooks idan bayanai sun canja?

Ba daga Gudanarwa → APIs ba, wanda ke amsa buƙatu kawai. Ku nemi MonstarX ya ƙara webhook a manhajarku — misali “idan an yi oda, tura ta (POST) zuwa wannan adireshin”.

Shafuka masu alaƙa

Gudanarwa ta manhajarkuInda APIs suke, tare da jadawalanku, masu amfani da tarihin ayyuka.

Rumbun bayanan manhajarkuJadawalan da tashoshin API ɗinku suke karantawa da rubutawa.

Bayanan sirri da maɓallan APIMaɓallan da manhajarku take amfani da su don wasu sabis.

Wakilan rubuta lambar tusheKu sarrafa MonstarX kansa daga Claude Code, Cursor da sauransu.