Transposit JavaScript SDK
SDK for web apps using Transposit as a backend.
- Call endpoints: Call your backend through an idiomatic library.
- Require sign-in: Ask users to sign in before interacting with your web app.
- Manage authentication: Allow users to grant access to their third-party data.
To learn more about Transposit as a backend, see the Transposit documentation.
Installation
Install with npm
or embed the library in a <script>
tag.
$ npm install transposit
Instantiate the SDK with the hosted app origin that uniquely identifies your application:
; const transposit = "https://hello-world-xyz12.transposit.io";
Call endpoints
Call your backend through an idiomatic library.
transposit // do it! ) ;
Sign-in
If your web app requires sign-in, implement these routes.
/signin
: Displays a sign-in button/handle-signin
: Handles redirection after successful sign-in
/signin
Create a page that displays a sign-in button. Use the SDK to begin sign-in when the button is clicked.
Sign in
Specify <your-site>/handle-signin
as a Successful sign-in URI when you enable user sign-in in Transposit.
/handle-signin
Create a page that handles redirection at the end of sign-in. Use the SDK to complete sign-in when the page loads. You do not need to render anything on this page if you redirect once sign-in is complete.
Signed in routes
For all routes that require sign-in, check if the user is signed in. Redirect to your sign-in page if they are not.
Sign-out
Render a sign-out button. Use the SDK to sign out when the buttons is clicked.
Sign out
Managed authentication
Allow users to grant access to their third-party data. Use the SDK to link users to the Transposit settings page.
Settings
FAQs
How do I use the SDK with React?
See our React tutorial.
I'm an SDK power user. Can you tell me more?
Absolutely! See the Transposit reference documentation.
I have a question about the SDK. Where should I ask?
File an issue against this repository.
I have a question about Transposit. Where can I learn more?
Check out the Transposit documentation. Email support@transposit.com.
License
The Transposit JavaScript SDK is licensed under the Apache License, Version 2.0.