Dokumentace k REST API OrImport

Toto API poskytuje přístup k funkcím OR-SYSTEM Open prostřednictvím jednoho endpointu avšak s rozlišením na úrovni atributů.

Pro přístup k API je vyžadována autentizace. Každý požadavek musí obsahovat platný autentizační token v hlavičce. Token je získán prostřednictvím přihlašovacího procesu.

• URL: `/auth/login`
• Metoda: `POST`
• Formát vstupu: `application/json`
• Formát výstupu: `application/json`

• `username` (string): Login do OR-SYSTEM Open.
• `password` (string): Heslo do OR-SYSTEM Open.

== Příklad požadavku: ==
<code json>
{
  "username": "uzivatel",
  "password": "tajneheslo"
}
</code>

== Příklad odpovědi: ==
<code json>
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
</code>

• URL: `/auth/logout`
• Metoda: `POST`
• Formát vstupu: `application/json`
• Formát výstupu: `application/json`

• `token` (string): Autentizační token, který má být zneplatněn.

== Příklad požadavku: ==
<code json>
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
</code>

== Příklad odpovědi: ==
<code json>
{
  "status": "OK"
}
</code>

• URL: `/auth/refresh`
• Metoda: `POST`
• Formát vstupu: `application/json`
• Formát výstupu: `application/json`

• `refreshToken` (string): Token pro obnovení autentizace.

== Příklad požadavku: ==
<code json>
{
  "refreshToken": "dGVzdHJlZnJlc2h0b2tlbg=="
}
</code>

== Příklad odpovědi: ==
<code json>
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "dGVzdHJlZnJlc2h0b2tlbg=="
}
</code>

• URL: `/orimport/data`
• Metoda: `POST`
• Formát vstupu: `application/json`
• Formát výstupu: `application/json`

• json (object): JSON reprezentující data k zpracování.

{
  "EntityType": "type1",
  "Id": "123",
  "Properties": {
    "PropertyDesciptor": [
      {"Name": "Property1", "Value": "Value1"},
      {"Name": "Property2", "Value": "Value2"}
    ]
  }
}

{
  "status": "success",
  "message": "Data were processed successfully."
}

V případě chyb nebo výjimek API vrací chybové zprávy s popisem problému.

KO Chybová zpráva

### Chybové stavy - Popis: API může vrátit chybové stavy při selhání interních operací. Specifické kódy chyb a popisy nejsou definovány.

### Logování - API loguje důležité operace do souboru. Formát a obsah logování nejsou plně specifikovány.

Tabulka s přípustnými hodnotami `EntityType`.

Request má strukturu, která je uvedena na příkladu volání SKL003:

Důležité atributy, které je potřeba naplnit:

• `gaTask` - jméno volby - ve vašem případě by to bylo SKL003
• `maska` - jméno tiskové masky - u vás skl003 (bude se hledat firemní)
• `program` - jméno programu skl003
• `listina` - název listiny - jméno vzniknuvšího souboru s obsahem reportu (nevrací se base64)
• `gaLp` - jméno výstupu (S = pdf), možno i tiskárna z COBCAP např. B_prodejna
• `login` - login pod kterým se provede spuštění
• Dále je potřeba naplnit požadované vstupní údaje GA volby. Např. `gatTyp01 = M` atd.

{
  "entityType": "OrImportServant",
  "id": "startPrint",
  "properties": {
    "propertyDesciptor": [
      {"name": "gaTyp01", "value": "M"},
      {"name": "gaTvon01", "value": "918277764"},
      {"name": "gaTvon02", "value": "918277764"},
      {"name": "gaTask", "value": "SKL003"},
      {"name": "maska", "value": "skl003"},
      {"name": "program", "value": "skl003"},
      {"name": "listina", "value": "LSKL003"},
      {"name": "gaLp", "value": "S"},
      {"name": "login", "value": "orfadmin"},
      {"name": "gaKom01", "value": "9B"}
    ]
  }
}

RESPONSE potom vrací jméno sestavy:

{
  "SetResponse": {
    "SetResult": {
      "DataChangeHandle": null,
      "DataDescriptorId": "startPrint",
      "Incidents": null,
      "InnerResults": null,
      "Message": "/dlf1/orfdat/firm/polna/listiny/LSKL003_6E.pdf",
      "OperationCategory": "Set",
      "Status": "Succeeded"
    }
  }
}