Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Maak een RAO admin account aan voor gebruik als API user. Het account moet hiervoor de juiste RAO Admin roles hebben (SSL, Client Certificate, etc).
    • Let op: kies een naam en gebruikersnaam waaruit blijkt dat het om een api-account gaat, bijv. Name: SURF API, Username: surf-api-user-1
    • Let op: voordat dit account gebruik kan worden moet eerst met de bijbehorende credentials worden ingelogd in SCM om het wachtwoord aan te passen. Vraag daarna aan scs-ra@surfnet.nl om 'WS API only' en 'Allow SSL auto approve' aan te zetten; alle andere privileges horen voor een API admin uit te staan.
    • Het wachtwoord dient uit maximaal 32 karakters te bestaan en moet niet-alfanumerieke karakters bevatten.
  • Requests moeten eerst goedgekeurd worden in SCM voordat het certificaat wordt uitgegeven. Als je wilt dat dit automatisch gebeurt, vink dan bij Privileges aan "Allow SSL auto approve".
  • Het is verstandig daarna login via de browser uit te zetten door de checkbox "WS API use only" aan te vinken. Als dat niet lukt: mail een MRAO via scs-ra@surfnet.nl om dat voor je te doen.
  • Vervolgens moet de API worden geactiveerd voor jouw organisatie, via Settings | Organizations. Edit de gewenste organisatie en de gewenste API (bij voorbeeld SSL Certificate), en vink de checkbox bij “Web API” 


    • Er verschijnt een tekstveld voor "Secret key". Deze wordt alleen gebruikt voor de Web Services (SOAP) API, niet voor de REST API. Je kunt hier iets willekeurigs invullen (mits voldoende entropie).

  • De API is nu klaar voor gebruik.

...