RemoteGymp · API v1

Andika data

Sasisha sehemu maalum na madirisha ya matengenezo, endesha otomatiki na ujaribu tena kuandika kwa usalama.

API na MCP zinaunga mkono kazi zilizoorodheshwa, nguvu iliyopangwa, kuondoa wakala, uchunguzi wa mwisho, kufutwa kwa amri na sera za kiraka za mtu wa tatu. Tumia tena funguo za idempotency na kagua risiti. Nywila za muda mfupi za msimamizi hurudishwa mara moja. Ukaguzi wa trafiki unahitaji ruhusa iliyopo; bili hubaki kwenye programu.

  1. Angalia ruhusa zako

    Vifaa vilivyowekwa awali huchagua uwezo wa mtu binafsi; havibadilishi kiwango cha ufikiaji. Vitambulisho vipya katika Mipangilio hutumia FullAccess kwa chaguo-msingi, lakini ni uwezo uliochaguliwa pekee unaoruhusiwa. Vitambulisho vya zamani vya ReadWrite huruhusu mabadiliko yaliyoidhinishwa ya sehemu maalum na matengenezo. Uendeshaji otomatiki na udhibiti wa kifaa unahitaji FullAccess pamoja na uwezo wao maalum. Angalia GET /v1/operations/capabilities kabla ya kuandika. Upeo wa kampuni na ruhusa za mmiliki wa sasa bado zinatumika.

  2. Epuka kuandika upya mabadiliko mengine

    Soma sehemu maalum na toleo lake. Tuma thamani yako mpya na toleo ulilosoma kwa PATCH /v1/custom-fields/{fieldId}. A 409 version_conflict inamaanisha mtu alibadilisha kwanza. Isome tena na uamue kama sasisho lako bado linafaa.

  3. Jaribu tena kwa usalama

    Kwa POST /v1/maintenance-windows, tuma kichwa cha Idempotency-Key. Baada ya matokeo yasiyo na uhakika, rudia ufunguo na mwili ule ule ili kupata dirisha la asili badala ya kuunda nakala rudufu. Mwili uliobadilishwa wenye ufunguo ule ule unakataliwa. DELETE /v1/maintenance-windows/{windowId} hughairi dirisha.

  4. Fuata risiti za vitendo

    Uandishi wa kiotomatiki na usimamizi hutumia idempotencyKey katika mwili wa JSON na urudishe risiti ya operesheni. Completed inamaanisha kidhibiti cha ombi kimekamilika; angalia matokeo au kikoa kinachoendeshwa ili kujua kama kifaa kimekamilisha kazi. Kwa OutcomeUnknown, kagua risiti na hali ya sasa kabla ya kuamua cha kufanya. Usitume tena kiotomatiki chini ya ufunguo mpya: kitendo kinaweza kuendeshwa mara mbili.

Marejeo ya API →

Marekebisho ya yaliyomo 3f225a253 · OpenAPI SHA-256: b12c42306a89