API Usage

Documentation for the Portal API
https://prtl.parcellab.com/api/signin
This endpoint allows you to generate unique Magic Links for signing in a user by clicking on it. A Magic Link can only be used once and is valid for 1 day. After expiration or if a Magic Link was used once, you have to generate a new one. You can generate Magic Links with prefilled searchbar input. The user will see the results immediately after signing in. You have to provide at least a username OR an email and the matching password.
Request
Response
Request
Headers
Content-Type
optional
string
application/json
Body Parameters
searchInput
optional
string
You can prefill the searchbar for the user. The results would be shown immediately after a successful signin.
username
required
string
The username of the user you want to sign in.
email
required
string
Optionally you can provide an email if the user was registered by email and has no username.
password
required
string
The password belonging to the username or email.
Response
200: OK
Magic Link successfully generated.
{
"magicLink": "https://prtl.parcellab.com/trackings/search?searchInput=dhl%20123&portaberto=xxxxxxxxxxxxxxxxx",
"expiresAt": "2020-08-11T14:08:25.950Z"
}
403: Forbidden
Username/email + password combination was wrong. In this case you should check if you are using the right parameter: "username" for username or "email" for email.
You are not authorized. [403]