Šajā dokumentācijā ir aprakstītas visas API metodes tālāk norādītajām darbībām.

• objektu sarakstu iegūšana (saraksta metode)
• saraksta filtrēšana (saraksta metode ar filtra datiem)
• detalizētas informācijas iegūšana par objektu (rādīšanas metode)
• datu iegūšana objekta pievienošanas formai (pievienošanas metode)
• datu saglabāšana kā jauns objekts (glabāšanas metode)
• datu iegūšana objekta atjaunināšanas veidlapai (rediģēšanas metode)
• atjauninātā objekta datu saglabāšana (atjaunināšanas metode)

API pieņem pieprasījumus tikai no ierobežota IP adrešu saraksta (piemēram, no klienta konta vietnes vai aizmugures biroja vietnes).

Jebkurš API pieprasījums no IP adreses, kas nav atļauto sarakstā, tiks noraidīts.

Tas tiek darīts, lai novērstu DDoS uzbrukumus API, mēģinājumus viltot pieprasījumus un hakeru eksperimentus.

Lietotāji vienmēr piekļūst platformas publiskajai vietnei (klienta birojam vai back office), un šī vietne pati pieprasa nepieciešamos datus no platformas API. Tā kā vietnes IP adrese ir fiksēta, tā būs atļauto sarakstā.

Visi API pieprasījumi tiek veikti, izmantojot šādas HTTP metodes:

• GET sarakstam, rādīšanai, pievienošanai un rediģēšanai
• POST veikalam
• PUT atjaunināšanai
• DELETE dzēšanai

Katrā API sadaļā ir URL, uz kuru tiek nosūtīts pieprasījums iegūt attiecīgos datus.

HTTP pieprasījuma metode ir norādīta katra URL priekšā.

Katrā API pieprasījumā vienmēr ir jāietver 4 mainīgie:

1. data (json virkne ar datu masīvu API)
2. user (json virkne ar datu masīvu par pašreizējo lietotāju)
3. time (pašreizējais laiks UTC laika joslā)
4. hash (digitālais paraksts jaucējkoda veidā, lai pārbaudītu, vai API pieprasījums noteikti ir no autorizēta avota)

Ja pieprasījums ir veiksmīgs, API vienmēr atgriež divus mainīgos:

1. status = true (veiksmes statuss)
2. data (json virkne ar datu masīvu no API)

Ja pieprasījums neizdodas, API parāda mainīgos:

1. status = false (kļūdas statuss)
2. error (teksta virkne, kas apraksta kļūdu)

Katrā API pieprasījumā ir jāietver jaukšanas mainīgais, kas ir pieprasījuma ciparparaksts.

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

• md5, sha256, bcrypt — pieejamie šifrēšanas algoritmi
• $json — json virkne ar pieprasījuma datiem
• $time — laiks formātā "DD.MM.GGGG HH:MM:SS"
• $salt — fiksēta unikāla vērtība ("sāls") platformas API