Déanann an doiciméadú seo cur síos ar gach modh API do na gníomhartha seo a leanas:

• liostaí réada a fháil (modh an liosta)
• scagadh liosta (modh liosta le sonraí scagaire)
• faisnéis mhionsonraithe a fháil faoi rud (modh taispeáin)
• sonraí a fháil don fhoirm add object (modh cuir leis)
• sonraí a shábháil mar réad nua (modh stórála)
• ag fáil sonraí don fhoirm nuashonraithe oibiachta (modh eagarthóireachta)
• sonraí an oibiachta nuashonraithe a shábháil (modh nuashonraithe)

Ní ghlacann an API ach le hiarratais ó liosta teoranta seoltaí IP (mar shampla, ó shuíomh cuntais chliaint nó ó shuíomh cúloifige).

Diúltófar d’aon iarratas chuig an API ó sheoladh IP nach bhfuil ar an liosta ceadaithe.

Déantar é seo chun ionsaithe DDoS ar an API a chosc, iarrachtaí chun iarratais a fhalsú agus turgnaimh hacker.

Bíonn rochtain i gcónaí ag úsáideoirí ar shuíomh poiblí an ardáin (oifig an chustaiméara nó cúloifig), agus iarrann an láithreán seo féin na sonraí riachtanacha ó API an ardáin. Ós rud é go bhfuil seoladh IP an tsuímh socraithe, beidh sé ar an liosta ceadaithe.

Déantar gach iarratas API ag baint úsáide as na modhanna HTTP seo a leanas:

• GET le haghaidh liosta, taispeáin, cuir leis agus cuir in eagar
• POST le haghaidh siopa
• PUT le haghaidh nuashonrú
• DELETE le scriosadh

Tá URL i ngach cuid den API a ndéantar iarratas chuige chun na sonraí ábhartha a fháil.

Tá an modh iarratais HTTP sonraithe os comhair gach URL.

Caithfidh 4 athróg a bheith i ngach iarratas API:

1. data (teaghrán json le eagar sonraí le haghaidh API)
2. user (teaghrán json le sraith sonraí faoin úsáideoir reatha)
3. time (am reatha i gcrios ama UTC)
4. hash (síniú digiteach i bhfoirm hais chun a fhíorú go bhfuil an t-iarratas chuig an API cinnte ó fhoinse údaraithe)

Má éiríonn leis an iarratas, filleann an API dhá athróg i gcónaí:

1. status = true (stádas ratha)
2. data (teaghrán json le eagar sonraí ón API)

Má theipeann ar an iarratas, taispeánann an API na hathróga:

1. status = false (stádas earráide)
2. error (teaghrán téacs ag cur síos ar an earráid)

Ní mór athróg hash a bheith i ngach iarratas API arb é síniú digiteach an iarratais é.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — halgartaim criptithe atá ar fáil
• $json — json teaghrán le sonraí iarratais
• $time — am san fhormáid "DD.MM.YYY HH:MM:SS"
• $salt — luach uathúil seasta ("salann") le haghaidh API ardán