SAM API
We bieden je de vrijheid om SAM aan je eigen website, webshop of andere online tool te koppelen, door middel van onze SAM REST API.
Welke functies biedt de SAM REST API?
Kort gezegd biedt de API op dit moment de volgende functies:
- Artikelgroepen ophalen, toevoegen, bewerken en verwijderen.
- Artikelen ophalen, toevoegen, wijzigen of verwijderen.
- Artikelprijzen voor relatie ophalen.
- Artikelleveranciers ophalen, toevoegen, bewerken en verwijderen.
- Batchnummers ophalen.
- Totale en beschikbare voorraad ophalen.
- Relaties en contactpersonen ophalen, toevoegen, bewerken en verwijderen.
- Projecten en projectprijzen ophalen.
- Projectdocumenten aanmaken.
- Servicedesk e-mails versturen.
- Projectstatussen ophalen.
- Weborders inschieten.
- Transportkosten ophalen, rekening houdend met de ingestelde uitzonderingen.
- Prijsberekening voor weborder ophalen.
- Facturen ophalen.
- Vestigingen ophalen.
Deze functionaliteit is onderdeel van de modules 'SAM API' en 'SAM Webshop'
Documentatie
De volledige specificaties vind je terug door naar https://[jouwsubdomein].samrental.nl/api/ te gaan. Heb je nog geen SAM omgeving? Dan kun je hier vrijblijvend een demo aanvragen.
API gebruikers
Externe koppelingen die gegevens ophalen, toevoegen of wijzigen in jouw SAM-omgeving doen dat met een API gebruiker. Dat kan een webshop zijn, een inhuurleverancier of een andere externe applicatie. Deze gebruikers en hun rechten kun je zelf in SAM beheren.
- Ga in SAM naar Instellingen > Externe koppelingen > Tabblad 'API-gebruikers'
- Klik rechts bovenin op 'API-gebruiker toevoegen'
- Geef de gebruiker een naam. Om de koppeling goed te laten werken, mag de naam alleen bestaan uit letters, cijfers en underscores.
- Geef de gebruiker de benodigde rechten. Maak je een gebruiker aan voor een inhuurlevernacier, geef deze dan minimaal rechten voor het plaatsen van weborders.
- Klik op 'Opslaan'. Er wordt op dat moment automatisch een Client secret voor je gegenereerd, die nodig is om van de koppelinge gebruik te kunnen maken.
- Geef vervolgens aan je API gebruiker de volgende gegevens door:
- De URL van jouw SAM-omgeving
- Client ID
- Client secret
OAuth autenticatie
Met de gegevens van je API gebruiker kun je ook in de documentatie autoriseren en de API uitproberen. Zo weet je precies op welke manier gegevens ingeschoten moeten worden en hoe je gegevens terugkrijgt uit SAM.
Voor de ontwikkelaar:
Om met je OAuth gegevens verbinding te maken met de SAM API stuur je een POST request naar https://<subdomein>.samrental.nl/api/webshop/v1/token met data grant_type=client_credentials& client_id=<client_id>&client_ secret=<client_secret>.
Vervolgens krijg je een access_token terug, met een datum tot wanneer die geldig is. Die twee velden moeten worden opgeslagen in het systeem van de webshop.
Bij de API calls voeg je vervolgens de volgende HTTP Header toe:
Authorization: Bearer <access_token>
Voor de ontwikkelaar:
Om met je OAuth gegevens verbinding te maken met de SAM API stuur je een POST request naar https://<subdomein>.samrental.nl/api/webshop/v1/token met data grant_type=client_credentials&
Vervolgens krijg je een access_token terug, met een datum tot wanneer die geldig is. Die twee velden moeten worden opgeslagen in het systeem van de webshop.
Bij de API calls voeg je vervolgens de volgende HTTP Header toe:
Authorization: Bearer <access_token>