Authentication

OAuth2

Deze API maakt gebruik van een OAuth2 authenticatie. Een account en API token is vereist om een access token aan te kunnen vragen. Deze kun je aanvragen via support@projectie.com

Registreren van een nieuwe applicatie

Het registreren van een nieuwe applicatie heeft een paar stappen. Deze stappen dienen te worden uitgevoerd voor een correcte werking van de API. Een volledige uitleg per resource method staat in een apparte kop beschreven

  1. Zorg dat je een account en een geldig API token hebt.
  2. Doe via jou applicatie een POST request naar de /authenticate URL en geeft de benodigde parameters mee.
  3. Sla de access token op die je terug krijgt uit de API
  4. Geef jou access token mee met de API requests die je wilt doen via de aangegeven token_type manier.
  5. Omdat een access token verloopt na een periode verloopt moet je zorgen dat jou applicatie automatisch een nieuwe aanvraagd wanneer deze verlopen is. Dit kan door bijvoorbeeld de expires_at uit de response op te slaan en wanneer deze verstreken is een nieuwe aan te vragen. Hoe je dit precies inricht is aan jou.

Authentication methods

POST: /authenticate

Registreer jou applicatie bij de API en krijg een access token zodat je requests kunt doen.
Parameters:
Key Beschrijving Noodzaak
email
Emailadres waarmee jou account registreerd is.
Verplicht
api_token De API token die hoort bij jou account. Verplicht
application_name Vul hier de naam van jou applicatie in. Verplicht
Response:
Key Beschrijving
access_token
De access token die bij deze registratie hoort. Bewaar deze goed. Deze heb je nodig om in het vervolg requests te kunnen doen.
token_type Dit geeft aan op welke manier je je met deze token moet authenticaten bij de API
expires_at Een datetime string met de verloop datum van de access_token

GET: /revoke

Vernietig jou access token. Om toegang te krijgen tot deze method dien je jezelf te authenticaten met een geldige access token via de aangegeven manier.
Roep deze methode aan om jou access token te vernietigen.