LiquidFiles Documentation
LiquidFiles Documentation
On This Page

Retrieve API key

If you want to retrieve the users API key from your application. You can use the following API call.

This should normally not be needed! LiquidFiles don't authenticate with Username/Email and Password, LiquidFiles authenticate with the API key!

Please note that even though we are using the users username and password to retreive the API key, we are not authenticating to the API using the users username and password. This is only to retrieve the API key. When you're saving the users credentials. Don't save the username and password and call this request every time. Save the API key, this is why it's there.

Request

Request Info
Info Value
Request URL /login
Request VERB POST
Response Parameters
Parameter Type Description
email String The users email or username (how you would enter it on the web login screen)
password String The users password

You can use any string that the user normally logs in with on the login page of the LiquidFiles system. If you've setup LDAP integration and are also authenticating the users sAMAccountName, you can use the users shortname instead of the email.

Example Retrieve API key using Curl

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{"user":{"email":"user@company.com","password":"secret"}}' \
  https://test.host/login

{"user":{"api_key":"nkpIxMK9ucUUE7FvfNpdAf"}}
Please note that you need to escape passwords properly.