REST API Endpoints 🚀

The SimpleAuth.link REST API provides three core endpoints that allow you to integrate secure, passwordless authentication into your application. These endpoints enable you to register your app, request tokens for user authentication, and verify the validity of those tokens.

Endpoints Overview 📋

1. Register Your App 📝

  • Endpoint: /apps
  • Purpose: Register a new application by submitting its configuration details, including the app name, session duration, redirect URL, and secret. This process generates a unique AppID that is used to identify your application and secure subsequent API requests. Learn More.

2. Request a Token 🔐

  • Endpoint: /token
  • Purpose: Request an authentication token for a user by providing their email address. The service generates a secure token using cryptographic methods and sends it via a magic link, enabling passwordless login. Learn More.

3. Verify a Token ✅

  • Endpoint: /verify
  • Purpose: Validate a received token to ensure it is authentic, unexpired, and properly associated with your application and the user. This step is critical for maintaining secure sessions. Learn More.

Getting Started 🚀

To integrate SimpleAuth.link into your platform:

  1. Register Your App: Use the POST /apps endpoint to generate a unique AppID and configure your application settings.
  2. Authenticate Your Users: Use the POST /tokens endpoint to request authentication tokens for your users, enabling a streamlined, passwordless login experience.
  3. Secure Your Sessions: Finally, verify each token with the PUT /tokens endpoint to ensure secure, authenticated sessions.

For more detailed information on each endpoint and additional implementation guidance, please follow the links provided above.

Table of contents