• Introduction
• auth
  • postSignup a user
  • postLogin a user
  • postLogout a user
• adminAuth
  • postLogin an admin
  • postLogout an admin
• profile
  • getme
• adminProfile
  • getme

Documentation Powered by Redocly

Pandora (1.0.0)

Download OpenAPI specification:Download

Introduction

API documentation for Pandora - REST API starter kit powered by Laravel, OpenAPI, Sanctum.

• GitHub
• MIT License

auth

User authentication

Signup a user

Signup a user.

Request Body schema: application/json

name required	string
email required	string <email>
password required	string
password_confirmation required	string

Responses

Local API server

http://localhost/api/signup

Request samples

• Payload

Content type

application/json

{

• "name": "John Doe",
• "email": "john@example.com",
• "password": "123456",
• "password_confirmation": "123456"

}

Response samples

• 201
• 422

Content type

application/json

{

• "user": {

  • "id": 1,
  • "name": "John Doe",
  • "email": "john@example.com",
  • "avatar_url": "https://someplace.com/avatar",
  • "created_at": "2022-08-27T16:14:46.000000Z"

  },
• "token": {

  • "access_token": "6|JeXDJdhmaQN4Nl3T3DaD9sE20PoPrdUx15W0m2eA",
  • "type": "bearer"

  }

}

Login a user

Login a user.

Request Body schema: application/json

email required	string <email>
password required	string

Responses

Local API server

http://localhost/api/login

Request samples

• Payload

Content type

application/json

{

• "email": "john@example.com",
• "password": "123456"

}

Response samples

• 200
• 401
• 422

Content type

application/json

{

• "user": {

  • "id": 1,
  • "name": "John Doe",
  • "email": "john@example.com",
  • "avatar_url": "https://someplace.com/avatar",
  • "created_at": "2022-08-27T16:14:46.000000Z"

  },
• "token": {

  • "access_token": "6|JeXDJdhmaQN4Nl3T3DaD9sE20PoPrdUx15W0m2eA",
  • "type": "bearer"

  }

}

Logout a user

Logout a user.

Authorizations:

BearerToken

Responses

Local API server

http://localhost/api/logout

adminAuth

Admin authentication

Login an admin

Login an admin.

Request Body schema: application/json

email required	string <email>
password required	string

Responses

Local API server

http://localhost/api/admin/login

Request samples

• Payload

Content type

application/json

{

• "email": "root@admin.com",
• "password": "123456"

}

Response samples

• 200
• 401
• 422

Content type

application/json

{

• "admin": {

  • "id": 1,
  • "name": "Admin",
  • "email": "root@admin.com",
  • "avatar_url": "https://someplace.com/avatar",
  • "created_at": "2022-08-27T16:14:46.000000Z"

  },
• "token": {

  • "access_token": "6|JeXDJdhmaQN4Nl3T3DaD9sE20PoPrdUx15W0m2eA",
  • "type": "bearer"

  }

}

Logout an admin

Logout an admin.

Authorizations:

BearerToken

Responses

Local API server

http://localhost/api/admin/logout

profile

User profile

me

Get the authenticated user.

Authorizations:

BearerToken

Responses

Local API server

http://localhost/api/profile

Response samples

• 200

Content type

application/json

{

• "id": 1,
• "name": "John Doe",
• "email": "john@example.com",
• "avatar_url": "https://someplace.com/avatar",
• "created_at": "2022-08-27T16:14:46.000000Z"

}

adminProfile

Admin profile

me

Get the authenticated admin.

Authorizations:

BearerToken

Responses

Local API server

http://localhost/api/admin/profile

Response samples

• 200

Content type

application/json

{

• "id": 1,
• "name": "Admin",
• "email": "root@admin.com",
• "avatar_url": "https://someplace.com/avatar",
• "created_at": "2022-08-27T16:14:46.000000Z"

}