weclapp API példák: kifizetetlen számlák, készlet és rendelések, kóddal vagy anélkül

A weclapp API két percben

A weclapp REST API-ja szinte mindent lefed, amit az alkalmazásban lát: cikkeket, vevőket és más partnereket, árajánlatokat, vevői rendeléseket, számlákat, szállításokat és raktárkészletet. Minden cégnek saját címe van:

https://your-company.weclapp.com/webapp/api/v2/

Minden kérés az AuthenticationToken fejlécben visz egy API-tokent. A token egy weclapp-felhasználóhoz tartozik, és annak a felhasználónak a jogaival rendelkezik. A személyes weclapp-beállításaiban hozhatja létre.

A listák az entitás nevén érhetők el, például /salesInvoice vagy /article. A munka nagy részét néhány lekérdezési paraméter végzi:

Paraméter	Mire való	Példa
<field>-eq és más operátorok	Szűrés egy mezőre	paymentStatus-eq=OPEN
properties	Csak a kiválasztott mezőket adja vissza	properties=invoiceNumber,dueDate,grossAmount
page és pageSize	Lapozás hosszú listákban	page=2&pageSize=100
/count	Darabszám lista helyett	/salesInvoice/count?paymentStatus-eq=OPEN

Az elérhető mezőket és operátorokat a saját weclapp-fiókjában, az interaktív API-referenciában ellenőrizheti.

1. példa: nyitott számlák

GET /webapp/api/v2/salesInvoice?paymentStatus-eq=OPEN&properties=invoiceNumber,invoiceDate,dueDate,grossAmount
AuthenticationToken: <your token>

A weclapp olyan fizetési állapotokat különböztet meg, mint az OPEN, a PAID és a NO_OPEN_ITEM. A lejárt számlákhoz a saját kódjában kell összevetnie a dueDate értékét a mai nappal. A weclapp a dátumokat időbélyegként tárolja, ezért megjelenítés előtt alakítsa át őket.

2. példa: hány nyitott számla van?

GET /webapp/api/v2/salesInvoice/count?paymentStatus-eq=OPEN

A válasz egyetlen szám. Ideális egy irányítópulthoz vagy egy gyors ellenőrzéshez.

3. példa: legutóbbi vevői rendelések

GET /webapp/api/v2/salesOrder?properties=orderNumber,orderDate,status,netAmount&pageSize=50

Az orderDate vagy a status mezőre tett szűrővel szűkítheti a listát. A vevőnkénti árbevételhez a rendeléseket össze kell kapcsolnia a partneradatokkal, és az eredményeket saját magának kell csoportosítania.

4. példa: készletszintek

GET /webapp/api/v2/warehouseStock?pageSize=100

A készletet cikkenként és raktáranként tárolja a rendszer. Ahhoz, hogy megválaszolja, „mely cikkek fogynak el hamarosan?”, az értékesítési előzményekre is szükség van, így ebből egy kisebb adatprojekt lesz.

Ahol az API drágává válik egy vállalkozásnak

A fenti kérések egyszerűek. A körülöttük lévő munka viszont nem:

• Adatok összekapcsolása. A legtöbb üzleti kérdés több entitást kombinál, például számlákat, partnereket és kifizetéseket.
• Lapozás és korlátok. A nagy listákhoz ciklusok, újrapróbálkozások és hibakezelés kell.
• A token védelme. A szkriptekben, táblázatokban és integrációs eszközökben hajlamosak felgyűlni a másolatai.
• Biztonságos írás. Egy rossz cikkre küldött PUT az élő adatait módosítja. Nincs beépített „kérem, előbb ellenőrizze” lépés.
• Karbantartás. Minden új kérdés új kódot jelent, és aki megírta, jövőre talán már nem lesz a cégnél.

Ugyanazok a válaszok kód nélkül

A Steward ugyanazt a weclapp API-t használja, de a csapata hétköznapi nyelven kérdez. A Steward már ismeri a weclapp entitásait, mezőit és szűrőit, így ő állítja össze a kéréseket, lapoz végig az eredményeken, és kapcsolja össze őket.

Ehelyett…	Kérdezze a Stewardot
1. példa	„Mely számlák lejártak, és összesen mekkora összeggel? Csoportosítsa őket vevő szerint.”
2. példa	„Hány számla van még nyitva?”
3. példa	„Hasonlítsa össze vevőnként az e negyedévi rendelési árbevételt az előző negyedévvel.”
4. példa	„Mely cikkek fogynak el két héten belül a jelenlegi értékesítési ütem mellett?”

Három dolog különbözik egy szkripttől:

1. A token védve marad. Egy adminisztrátor egyszer csatlakoztatja a weclappot. A tokent titkosítva tároljuk, és soha nem jelenik meg. Az MI sem kapja meg soha. Az elemzésekhez a Steward által írt kód az Ön hitelesítő adatai nélkül fut.
2. Projektszerepkörök. A Megtekintők követhetik az eredményeket, a Közreműködők használhatják a beállított kapcsolatokat és módosításokat készíthetnek elő, a Projektmenedzserek pedig jóváhagyhatnak. A meghívott projekttagoknak nem kell külön kapcsolati hozzáférés.
3. A módosítások jóváhagyásához vagy elutasításához Projektkezelő hozzáférés kell a javaslat projektjében. A Közreműködők előkészíthetik a módosításokat és áttekinthetik a részleteket. Végrehajtás előtt a rendszer újra ellenőrzi a végrehajtó aktuális projekthozzáférését és a kapcsolat engedélyezését.

Mikor használja közvetlenül az API-t?

Az API-t közvetlenül állandó integrációkhoz használja, például egy webshop szinkronizálásához, egy logisztikai szolgáltató bekötéséhez vagy saját alkalmazás fejlesztéséhez. A Stewardot arra a több száz kérdésre használja, amelyet a csapata ezek között az integrációk között tesz fel. Ezek a kérdések ritkán indokolnak fejlesztőt, szkriptet és karbantartási tervet.

Első lépések

Csatlakoztassa a weclappot, engedélyezze egy projektben, és tegye fel a fenti kérdések egyikét Csak olvasás módban. Az MI-megoldások tágabb összehasonlításáért olvassa el a Hogyan kérdezheti MI-vel a weclappot című cikket.