Pointsharp API Portal

The Pointsharp API Portal provides documentation and examples of how to use the APIs to interact with the Pointsharp ID. The enabled APIs are the Pointsharp Web API and the Pointsharp ID Plugin API.

  • The Pointsharp ID Web API is a REST API towards core functionalities of the Pointsharp ID, for example, performing an authentication request towards the Pointsharp ID.

  • The Pointsharp ID Plugin API is used to implement extended features to the Pointsharp ID, for example, creating a custom authentication method to be used within the Pointsharp ID.

The following services are offered by the Web Services API:

  • Authentication

  • Authorization

  • Device management

  • Notification

  • Token management

  • Password management

  • User management

Check API availability via Powershell

Use Powershell to perform a quick test towards the API on the Pointsharp ID Server to make sure it is up and running and responding properly.

Execute the command

Run the command directly in Powershell. Example:

Invoke-RestMethod -Method Post -Uri "https://psidserver.local/api/an" -Body (ConvertTo-Json @{username="testuser";password="testpassword";method="Windows Password"}) -ContentType "application/json"

Edit these parameters to fit your environment:

  • "https://psidserver.local/api/an" (add the Fully Qualified Domain Name for the PSID Server)

  • username="testuser"

  • password="testpassword"

  • method="Windows Password" (the authentication method to test against)