This is Casdoor's SDK for js will allow you to easily connect your application to the Casdoor authentication system without having to implement it from scratch.
Casdoor SDK is very simple to use. We will show you the steps below.
# NPM
npm i casdoor-js-sdk
# Yarn
yarn add casdoor-js-sdk
Initialization requires 5 parameters, which are all string type:
Name (in order) | Must | Description |
---|---|---|
serverUrl | Yes | your Casdoor server URL |
clientId | Yes | the Client ID of your Casdoor application |
appName | Yes | the name of your Casdoor application |
organizationName | Yes | the name of the Casdoor organization connected with your Casdoor application |
redirectPath | No | the path of the redirect URL for your Casdoor application, will be /callback if not provided |
signinPath | No | the path of the signin URL for your Casdoor application, will be /api/signin if not provided |
import {SDK, SdkConfig} from 'casdoor-js-sdk'
const sdkConfig: SdkConfig = {
serverUrl: "https://door.casbin.com",
clientId: "014ae4bd048734ca2dea",
appName: "app-casnode",
organizationName: "casbin",
redirectPath: "/callback",
signinPath: "/api/signin",
}
const sdk = new SDK(sdkConfig)
// call sdk to handle
Initialization parameters are consistent with the previous node.js section:
<!--init the SDK-->
<script type="module">
//Import from cdn(you can choose the appropriate cdn source according to your needs), or just from the local(download the casdoor-js-sdk first)
import SDK from 'https://unpkg.com/casdoor-js-sdk@latest/lib/esm/sdk.js'
const sdkConfig = {
serverUrl: "https://door.casbin.com",
clientId: "014ae4bd048734ca2dea",
appName: "app-casnode",
organizationName: "casbin",
redirectPath: "/callback",
signinPath: "/api/signin",
}
window.sdk = new SDK(sdkConfig)
</script>
<script type="text/javascript">
function gotoSignUpPage() {
window.location.href = sdk.getSigninUrl()
}
</script>
getSignupUrl(enablePassword)
Return the casdoor url that navigates to the registration screen
getSigninUrl()
Return the casdoor url that navigates to the login screen
getUserProfileUrl(userName, account)
Return the url to navigate to a specific user's casdoor personal page
getMyProfileUrl(account)
signin(serverUrl, signinPath)
Handle the callback url from casdoor, call the back-end api to complete the login process
isSilentSigninRequested()
We usually use this method to determine if silent login is being used. By default, if the silentSignin parameter is included in the URL and equals one, this method will return true. Of course, you can also use any method you prefer.
silentSignin(onSuccess, onFailure)
First, let's explain the two parameters of this method, which are the callback methods for successful and failed login. Next, I will describe the execution process of this method. We will create a hidden "iframe" element to redirect to the login page for authentication, thereby achieving the effect of silent sign-in.
To see how to use casdoor frontend SDK with casdoor backend SDK, you can refer to examples below:
casnode: casdoor-js-sdk + casdoor-go-sdk
casdoor-python-vue-sdk-example: casdoor-vue-sdk + casdoor-python-sdk
A more detailed description can be moved to:casdoor-sdk