Login

Authenticates a user and returns the user object.

POST /auth/login

Login

cURL

curl --request POST \
  --url https://open.beatpass.ca/api/v1/auth/login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "password": "password",
  "token_name": "iphone 12"
}
'

import requests

url = "https://open.beatpass.ca/api/v1/auth/login"

payload = {
    "email": "[e-mail]",
    "password": "password",
    "token_name": "iphone 12"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '[e-mail]', password: 'password', token_name: 'iphone 12'})
};

fetch('https://open.beatpass.ca/api/v1/auth/login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.beatpass.ca/api/v1/auth/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[e-mail]',
    'password' => 'password',
    'token_name' => 'iphone 12'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.beatpass.ca/api/v1/auth/login"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\",\n  \"password\": \"password\",\n  \"token_name\": \"iphone 12\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://open.beatpass.ca/api/v1/auth/login")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\",\n  \"password\": \"password\",\n  \"token_name\": \"iphone 12\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/auth/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[e-mail]\",\n  \"password\": \"password\",\n  \"token_name\": \"iphone 12\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "user": {
    "id": 123,
    "display_name": "<string>",
    "avatar": "<string>"
  }
}

"<unknown>"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email · string

Example:

"[e-mail]"

password · string

Example:

"password"

token_name · string

Example:

"iphone 12"

Response

200

application/json

Operation successful

status · string

Example:

"success"

user · object

Show child attributes