RestAPI till Pyramid

Med detta RestAPI för Pyramid öppnas ett gränssnitt upp för andra programvaror att extrahera data från Pyramid samt infoga data till Pyramid, på ett modernt sätt.

Via en egenutvecklad IIS-Brygga till Pyramid kan vi via anrop till en IIS-Site ta emot anrop och behandla dem i Pyramid för att sedan skicka tillbaka ett svar till anropande system.
Detta kan t.ex. vara att en extern webbshop vill ha artikeldata (saldo, pris etc.) från Pyramid, eller ett mobilt arbetsordersystem som levererar order och fakturaunderlag till Pyramid.

API:et hanterar Get- & Post- kommandon, där Get extraherar data från Pyramid och där Post både kan uppdatera och skapa en registerpost i Pyramid.
Allt sker via anrop till angiven IIS-site, med specificerade endpoints (funktioner).

I dagsläget finns det ca. 40 färdiga endpoints/funktioner.
Möjligheten finns även att skapa kundunika endpoints/funktioner.

Notera att inloggning krävs för att se all detaljinformation nedan.

En IIS-site tillsammans med ett giltigt certifikat måste sättas upp och installeras på kundens server.

Autentisering görs enligt Basic Token.

Header:n måste bestå av key value pairs ”Authorization” och ”CompanyInfo”.

Vid get-kommandon skall även Endpoint och Value vara i Headern.

För post-kommandon ska Endpoint och Value vara i body:n.
Body:n består av ett key value pair som motsvarar den endpoint/funktion som ska användas, samt för varje endpoint/funktion specificerad data som Value.

Svaret returneras i utf8-format, med standard svarskoder för http.

För de endpoints/funktioner med JSON-stöd returneras svar enligt JSON format.
I annat fall returneras svar alltid enligt specifikation för varje endpoint/funktion.

För de endpoints/funktioner med stöd för JSON skall tecken och teckenersättning hanteras enligt JSON-standard.

För alla andra endpoints/funktioner är vissa tecken förbjudna som värden i Value, om de inte är med som avgränsare.

I API-paketet levereras det även med ett antal LIB, nya datafält, nya register, nya index, nya dialoger samt några ändrade standarddialoger.

Som partner kan du testa anrop till vår demomiljö, se anropsdetaljer nedan (partnerinloggning krävs). 

ENDPOINTS / FUNKTIONER

Nedan specificeras de endpoints/funktioner som i dagsläget finns tillgängliga.
Observera att alla inte behöver vara aktiverade för varje kund/uppsättning.

Generella

Används för att skicka tillbaka värdet i Value som svarstext. 

Hämtar tabellinfo för angiven tabell (samt vissa register). Som t.ex. enheter, transportsätt, betalningsvillkor etc.
Värde som hämtas är posternas kod samt dess benämning/beteckning. 

Hämtar ändringar för angivet register per angivet datum.
Registerloggning i Pyramid måste vara påslagen för det register som ändringar ska hämtas ifrån. 

Registerutdrag för valfritt angivet indexregister i Pyramid.
Value och Svar enligt JSON-format.

Artiklar

Används för att hämta valfri data från artikelregistret, för angiven artikel. 

Hämta valfri artikeldata på flera angivna artiklar.
Kundpris för angiven kund samt lagersaldo kan även hämtas. 

 

Hämta angiven artikels benämning. 

Hämta angiven artikels grundpris.  

Hämta lagersaldo på angiven artikel. 

Hämta lagersaldo på alla lagerförda artiklar i Pyramid (kategori 1) 

Hämtar disponibelt antal (saldo-reserverat) på angiven artikel. 

Hämta disponibelt antal (saldo-reserverat) på alla lagerförda artiklar i Pyramid (kategori 1). 

Hämtar reserverat antal på angiven artikel. 

Hämtar beställt antal på angiven artikel.
Beställt antal avser beställt från inköpsorder och lageromföring. 

Hämtar transaktioner på angiven artikel på angivet datum. 

Används för att uppdatera och/eller skapa en artikel. 

Kunder och Leverantörer

Hämta företagsnamn från matchande företagskod i Pyramid. 

Hämtar angiven kunds pris exkl. moms på angiven artikel. 

Se getItemDataBatch

Hämta reskontrabalans för angiven kund. 

Hämtar kunds alla fakturor, från ett visst fakturadatum till idag. 

Hämtar angiven kunds öppna (obetalda) fakturor. 

Hämtar metadata enligt Base64 för angiven fakturas bildfil. 

Hämta värde av öppna order/orderrader för angiven kund. 

Hämtar angiven kunds orders med leveransinformation på dess orderrader. 

Används för att uppdatera och/eller skapa en artikel. 

Orders

Hämta Pyramids ordernummer baserat på externt order-id. 

Hämtar orderstatus för angiven order i Pyramid. 

Hämta leveransinformation på angiven orders rader. 

Skapar ny order i Pyramid.
Endast en order per meddelande. 

Skapar fakturaunderlag i Pyramid (transaktioner skapas direkt).
Endast en order per meddelande. 

Kan skapa en ny order, uppdatera en order och leverera ut orderrader för en order, fakturera en order etc.
Denna kan användas istället för fv_PostNewOrder och fv_PostNewInvoice. 

Lagerfunktioner

Uppdaterar Pyramid med inventerat antal på en artikel. 

Används för att leverera in en inköpsrad. 

Logga in för att få mer detaljinformation