API-koppeling en sandboxomgeving activeren

Hoe activeer je een API-koppeling en sandboxomgeving?

Voor het ontwikkelen van een API-koppeling start je in de sandboxomgeving. De API moet eerst worden aangezet, waarna je de koppeling in de shop kunt activeren en de integratie kunt ontwikkelen op de sandboxomgeving.

Hoe zet je API-toegang aan?

1. Vraag API-toegang aan.
2. Laat de API vervolgens aanzetten.
3. Activeer de API daarna in de shop.
4. Gebruik voor de ontwikkeling de sandboxomgeving.

Welke omgeving gebruik je voor ontwikkeling?

De integratie kan in eerste instantie worden ontwikkeld op de sandboxomgeving: sandbox-app.brincr.com. Daar kan een account worden aangemaakt voor de ontwikkeling van de koppeling.

Hoe werkt de sandboxactivatie?

Voor sandboxgebruik moet de API op de sandboxomgeving worden opengezet. Daarna kan de koppeling daar worden gebouwd en getest.

Welke stappen horen bij sandboxactivatie?

1. Maak een account aan in de sandboxomgeving.
2. Vraag toegang aan voor de sandboxadministratie.
3. Laat de API openzetten op de sandboxomgeving.
4. Ontwikkel de integratie in deze omgeving.

Hoe bereid je een productie-koppeling voor?

Voor productie moeten eerst de gedocumenteerde stappen worden gevolgd. Een productie-integratie wordt pas toegankelijk nadat de sandboxvalidatie en testuitvoering succesvol zijn afgerond.

Welke voorwaarden gelden voor productie?

1. Er moet een sandboxvalidatie zijn aangevraagd.
2. Er moet een test run zijn uitgevoerd.
3. De test moet representatief zijn voor het verwachte productiegebruik.
4. Alle aangevraagde scopes moeten worden getest.
5. De test moet foutloos verlopen.

Welke documentatie en omgevingen worden gebruikt?

De API-documentatie beschrijft twee flows:

• sandboxtraject
• productietraject

Bij het ontwikkelen op de sandboxomgeving wordt ook gebruikgemaakt van de stagingomgeving van het Visma Developer Portal.

Belangrijke locaties

• API-documentatie: api-docs.brincr.com/documentation
• Sandboxomgeving: sandbox-app.brincr.com
• Visma Developer Portal stagingomgeving: oauth.developers.stagaws.visma.com

Welke gebruikslimieten gelden voor de API?

Voor de Brincr API gelden rate limits:

• maximaal 60 calls per minuut
• maximaal 6500 calls per dag

Als deze limieten niet toereikend zijn, kan een verhoging worden aangevraagd.

Samenvatting

Start een API-koppeling in de sandboxomgeving, gebruik de API-documentatie als leidraad en vraag productie-toegang pas aan nadat de sandboxvalidatie en test run succesvol zijn afgerond.