11. API Externe

Un API Extern este o interfață software furnizată de un serviciu terță parte care oferă posibilitatea de a interoga date din acel serviciu pentru a le afișa în SocrateCloud. 

API Externe

 În fereastra API Externe se definesc interfețele externe care vor putea fi apelate din SocrateCloud. 

Notă: La acest moment SocrateCloud suportă doar apeluri către interfețe externe REST API.

Se completează câmpurile:

• Denumire - o denumire pentru a identifica serviciul extern

• URL bază - partea comună a URL-ului serviciului API apelabil prin HTTP/HTTPS

• Tip Autentificare - indică tipul de autentificare folosit de API

  • Fără autentificare - API-ul nu necesită autentificare

  • API Key - autentificare cu API Key care se transmite ca header

• Denumire Cheie - Numele header-ului pentru API Key

• Valoare Cheie - Cheia API obținută de la serviciul extern

• Format Dată - Formatul valorilor de tip dată care sunt returnate de API-ul extern. Implicit este ISO Date

• Format Dată+Timp - Formatul valorilor de tip dată+timp care sunt returnate de API-ul extern. Implicit este ISO DateTime

Endpoints

În tabul Enpoints se definesc endpoint-urile care pot fi apelate din API-ul extern. Un API extern poate avea unul sau mai multe endpoint-uri.

Se completează câmpurile:

• Denumire - o denumire pentru a identifica endpoint-ul

• Path - calea din URL specifică endpoint-ului relativ la URL bază din definiția API Extern tabul principal

În câmpul URL se va afișa url-ul complet al endpoint-ului.

Parametri

În tabul Parametri se pot defini parametri care vor fi transmiși în url sub formă de query string.

Se completează câmpurile:

• Denumire - numele parametrului așa cum va fi transmis în query string

• Valoare - valoarea parametrului. Aceasta poate fi o valoare fixă sau o variabilă de context.
  Dacă valoarea este o variabilă de context care la momentul apelului nu poate fi rezolvată din context atunci acel parametru nu se va transmite.

Câmpuri

În tabul Câmpuri se definesc câmpurile de interes din răspunsul JSON obținut la apelul API.

Se completează câmpurile:

• Cod - este un cod care identifică unic câmpul

• Referința - tipul valorii cîmpului

• Denumire - denumirea câmpului

• Cale în JSON - calea absolută a câmpului în JSON. 

Ex. Pentru următorul JSON:

{

    "data": [

        {

            "DocumentNo": "ABC123",

            "Description": null,

            "DocDate": "2024-04-19 00:00:00+0000",

            "lines": [

                {

                    "Line": 10,

                    "Product": "Piatra",

                },

                {

                    "Line": 20,

                    "Product": "Nisip",

                }

            ]

        }

    ]

}

calea în JSON este următoarea:

• pentru DocumentNo: /data/DocumentNo

• pentru Product din lines: /data/lines/Product