...
Variable Name | Description | Example Content |
|---|---|---|
apiUser | This is the username of the user you wish to use the API with. |
|
apiPw | The password for the user |
|
host | The hostname of your site | https://abc.edu.net.au |
Logging In
You
| Note |
|---|
BE ADVISED Do not use online tools to generate your base64 encoded logins as these 3rd party sites may store the login credential resulting in a significant risk to the security of your Paradigm site. |
To use the API you will need to set the HTTP Authorization header as “Basic {{encodedPassString}}”. The encoded pass string is your a base64 encoded form of the following information: username:password encoded in base64.
| Note |
|---|
Do not use online tools to generate your base64 encoded logins. This introduces a HEAVY security risk in sharing with not only the site, but any other software on your system that might intercept the header. |
On Windows you can do this in PowerShell
Use the following examples as a guide on how to correctly generate a base64 encoded text string. Replace the parameters username and password with the values you want to use on your Paradigm site.
Windows Command Prompt:
| Code Block | ||
|---|---|---|
| ||
powershell "[convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes(\"username:password\"))" |
Just replace username and password with the values you want to set.
...
Windows PowerShell:
| Code Block | ||
|---|---|---|
| ||
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("username:password")) |
Linux Bash:
| Code Block | ||
|---|---|---|
| ||
echo 'username:password' | base64 |
...
Example Requests
In the top menu, you have the option to select the LANGUAGE - as in the programming language or method that you will be using to connect to the API.
By default this is curl:
...