How to login to Hypi App instance using REST API

After the posts on File upload, you must have become acquainted with the file upload and download process.

We will now proceed with the REST APIs provided by Hypi’s low code platform.

RESTful APIs provide authentication and CRUD functionalities. They conform to the constraints of the REST architectural style and allow interaction with RESTful web services.

In this post, we will see how to login to a Hypi App instance using REST API. We will use the username and password of an account to login. Login can be triggered using either GET or POST method.

GET method:

Here is the cURL request to login using GET. Username and Password are provided in the URL as query parameters.

curl --location --request GET 'https://api.staging.hypi.dev/rest/v1/fn/query/login?username=Hypi-Customer1&[email protected]&type=query' \
--header 'hypi-domain: inclemency.apps.hypi.app' \
--header 'content-type: application/json' 

POST method:

Here is the cURL request to login using POST. The username and password are provided as input data.

curl --location --request POST 'https://api.staging.hypi.dev/rest/v1/fn/query/login' \
--header 'hypi-domain: inclemency.apps.hypi.app' \
--header 'content-type: application/json' \
--data-raw '{
      "username": "Hypi-Customer1",
      "password": "[email protected]"
}'

In the above requests, replace the username and password with your own set of values. Change the Hypi domain as well.

Check the Hypi REST APIs POSTMAN collection for the account login requests in different programming languages! Click </> and choose the programming language of your choice.

Run in Postman