Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Izmantotā SERP versija ir 8.5 2019-06-05 build 85310221, testēts, izmantojot Postman.

...

  1. Sistēma → Iestatījumi → Papildus funkcijas Atķeksēt iestatījumus: ☑ Web REST API un, ja izmanto Basic Auth - ☑ Atļaut HTTP autentifikāciju.
  2. HTTPS ieslēdz caur Tehniskie parametriIestatījumiProgrammas statuss → sadaļa WWW, pirms tam gan servera mapē jābūt ielinkotai SSL sertifikātu mapei:
    1. ieķeksēt ☑ HTTPS
    2. norādīt web portu, HTTPS portu
    3. Sertifikāts laukā norādīt domēna fullchain.pem failu
    4. Privātā atslēga - privkey.pem failu
    5. servera restarts
  3. REST API lietotājam (SistēmaReģistriPersonas laukā Personu grupas) izveido jaunu vai piešķirt kādu esošo Personu grupu (SistēmaIestatījumiPersonu grupas) ar tiesībām:

    DarbībaRest APIPilns0


  4. Tehniskie parametri (vecākās versijās Tīmekļa veikals) → Iestatījumi → Piekļuve funkcijām caur tīmekli
    1. izveido rindiņu, kas izskatās apmēram šādi:
      Image Added
    2. piemērā redzamā rindiņa atļaus jebkādus API savienojumus uz SERP sistēmu, kura linka sākums izskatīsies šādi - http://localhost:8085/api/
    3. pārējos laukus var izmantot, lai ierobežotu pieeju šim API endpointam, piem., ļaujot tikai SSL savienojumus vai savienojumus no konkrētām IP.
  5. API pieprasījumi tiek sūtīti uz http://localhost:8085/api/1/IVVc , kur:

    1. localhost:8085 ir links uz SERPu, ja manuāli norādām portu - izmantojam HTTP vai HTTPS;

    2. api/ norāda, ka izmantos REST API;

    3. 1/ norāda uz kompānijas kodu no kompāniju iestatījumiem;

    4. IVVc šajā gadījumā ir Rēķinu reģistrs, bet tur var norādīt jebkuru, arī custom vai block reģistru, ar kuru vēlas strādāt;

...

  • -X nosaka pieprasījuma metodi;
  • -u - Basic Auth lietotāju un tā paroli;
  • pieprasījuma links pēdiņās (der gan ", gan ');
  • -d  - satur linka parametrus arī pēdiņās, iekšā vērtībās var būt atstarpes, katru parametru atdala ar &.

...

Piem.,  http://localhost:8085/api/1/IVVc?set_field.SerNr=99999&set_field.CustCode=10101&set_row_field.0.ArtCode=10&set_row_field.0.Quant=7 - klientam 10101 izveidos rēķinu Nr. 99999 ar 7 artikuliem Nr.10 pirmajā rindā.

(warning) Ja nepieciešams padot datus, kas satur kādus īpašus simbolus, kas var tikt pārkodēti (piemēram, atstarpe), tad nevar padot šīs vērtības kā URL parametrus, bet gan viss saturs ir padodams kā POST body (ar text/plain satura tipu).

Piemērs ar Postman:

Image Added

PATCH

Ar PATCH metodi rediģē esošu ierakstu. Esošajam ierakstam piekļūst jau izsaukuma URL norādot MainKey lauka vērtību.

...

Kur 1234 ir SerialNr un 420324 ItemCode.

Sekvences numuri

Katrs REST API pieprasījums iekš <data> taga atgriež numuru sequence, kuri pieaug kaut kā. To var izmantot, atceroties katra pieprasījuma atbildes sekvenci un, kad no jauna kaut kādi dati jāiegūst, var izmantot šo skaitli inkrementālajam importam.

<data register="ORVc" sequence="16197" sort="SerNr" key="SerNr" systemversion="8.5.31.221">

TODOs:

  •  English, do you speak it?