Authentication

Welcome to the Riverty Parking API Integration Guide. Below you’ll find the necessary steps to get started with our API in the test environment. This guide includes information on authentication, endpoint details, and example requests and responses.

Authentication: Auth0 Token Exchange

Our API requires Auth0 Authentication to access the endpoints. Follow these steps to obtain an access token:

Token Request Structure:

The token exchange request must contain the following key-value pairs in the request body:

Key	Description	Example Value
client_id	Riverty Parking client ID (provided by Riverty).	[Your Client ID]
client_secret	Your client secret (provided by Riverty).	[Your Client Secret]
audience	Defines the endpoints the token is used for. Always set this to https://api.horizonafs.io.	https://api.horizonafs.io
grant_type	The method for obtaining the access token. Always set this to client_credentials.	client_credentials

Example Token Request

--url 'https://identity.horizonafs.io/oauth/token' \
--data-body '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "audience": "https://api.horizonafs.io",
  "grant_type": "client_credentials"
}'

Example Token Response

{
  "access_token": "eyJh...",
  "scope": "read:userprofile fullcontrol:users",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Response Parameters:

Property	Description
access_token	The JWT token containing your access privileges. Keep it secure and avoid exposing it in public repositories like GitHub.
scope	The permissions and access rights assigned to the token.
expires_in	Token validity duration in seconds.
token_type	Token type. In our response, it is always Bearer, indicating bearer token authentication.