Giter Club home page Giter Club logo

casdoor-js-sdk's Introduction

casdoor-js-sdk

NPM version NPM download codebeat badge GitHub Actions GitHub Actions Coverage Status Release Gitter

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.

Usage in NPM environment

Installation

# NPM
npm i casdoor-js-sdk

# Yarn
yarn add casdoor-js-sdk

Init 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

Usage in vanilla Javascript

Import and init SDK

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>

Call functions in SDK

<script type="text/javascript">
  function gotoSignUpPage() {
    window.location.href = sdk.getSigninUrl()
  }
</script>

API reference interface

Get sign up url

getSignupUrl(enablePassword)

Return the casdoor url that navigates to the registration screen

Get sign in url

getSigninUrl()

Return the casdoor url that navigates to the login screen

Get user profile page url

getUserProfileUrl(userName, account)

Return the url to navigate to a specific user's casdoor personal page

Get my profile page url

getMyProfileUrl(account)

Sign in

signin(serverUrl, signinPath)

Handle the callback url from casdoor, call the back-end api to complete the login process

More examples

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.