Getting started overview

Getting started with LoginRadius involves a sequence of steps to integrate its Customer Identity and Access Management (CIAM) platform into an application. The foundational process begins with account creation, followed by the generation and secure handling of API credentials. These credentials are then used to make an initial authenticated request to the LoginRadius API, typically for user registration or authentication, confirming the setup is operational. LoginRadius provides SDKs for various programming languages to streamline this integration, abstracting direct HTTP request handling.

LoginRadius supports several core products including Single Sign-On (SSO), Multi-Factor Authentication (MFA), and passwordless login, all accessible through its unified API. The platform is designed for scalability and aims to assist with regulatory compliance for user data, such as GDPR and CCPA LoginRadius compliance overview. Developers can choose to integrate using one of the many available SDKs or by making direct API calls. The free Developer Plan allows up to 25,000 users, providing a starting point for evaluation and development LoginRadius pricing page.

Quick reference table

Step What to do Where
1. Create Account Sign up for a LoginRadius Developer Plan. LoginRadius pricing and sign-up
2. Obtain Credentials Locate your API Key and API Secret in the Admin Console. LoginRadius Admin Console (under 'Configuration' > 'API Credentials')
3. SDK/API Setup Install the relevant SDK or prepare your HTTP client. LoginRadius SDK documentation
4. First Request Make an authenticated call (e.g., user registration). LoginRadius user registration API reference

Create an account and get keys

To begin using LoginRadius, the first step is to establish a developer account. This can be done by signing up for the free Developer Plan, which supports up to 25,000 users and provides access to core CIAM features LoginRadius Developer Plan details. During the signup process, you will typically provide basic contact information and set up your initial administrative credentials.

Once your account is active and you have logged into the LoginRadius Admin Console, you will need to retrieve your API credentials. These credentials are vital for authenticating all API requests and linking your application to the LoginRadius platform. The primary credentials required are:

  • API Key (Site Name): This identifies your application or site within LoginRadius. It is often publicly visible in client-side code (e.g., JavaScript SDK integrations).
  • API Secret: This is a confidential key used to sign server-side requests and must be kept secure. It should never be exposed in client-side code.

You can locate these credentials within the Admin Console, usually under a section like 'Configuration' or 'API Credentials'. It is recommended to store your API Secret securely, such as in environment variables, and avoid hardcoding it directly into your application's source code. For local development, environment variables are a common practice to manage sensitive information MDN Web Docs on environment variables.

Your first request

After obtaining your API Key and API Secret, you are ready to make your first authenticated request to the LoginRadius API. This initial request serves to verify that your setup is correct and that your credentials are valid. A common first request is to register a new user, which involves interacting with the Authentication API.

LoginRadius offers SDKs for various programming languages, including JavaScript, Java, PHP, Python, Ruby, .NET, Node.js, Android, and iOS LoginRadius SDKs overview. Using an SDK is often the simplest way to get started, as it handles the underlying HTTP requests and authentication mechanisms.

Here's an example of how you might initiate a user registration using the JavaScript SDK (client-side):


// Initialize LoginRadius SDK with your API Key
var commonOptions = {};
commonOptions.apiKey = 'YOUR_LOGINRADIUS_API_KEY';
var LRObject = new LoginRadiusV2(commonOptions);

// Example: Register a user
var registrationData = {
  Email: [{
    Type: 'Primary',
    Value: '[email protected]'
  }],
  Password: 'StrongPassword123!',
  FirstName: 'Test',
  LastName: 'User'
};

LRObject.authentication.api.registration(registrationData, function(response) {
  console.log('Registration successful:', response);
}, function(errors) {
  console.error('Registration failed:', errors);
});

For server-side requests, such as validating a user's access token or managing user profiles, you would typically use an SDK for your backend language (e.g., Node.js, Python, Java) and include your API Secret. Server-side requests often involve signing the request with your API Secret to ensure authenticity and integrity, a practice common in OAuth 2.0 implementations for secure API access OAuth 2.0 specification.

For direct API calls without an SDK, you would construct an HTTP POST request to the appropriate endpoint (e.g., https://api.loginradius.com/identity/v2/auth/register) and include the necessary JSON payload and headers, including your API Key and potentially an API Secret for server-side operations. Always refer to the specific API reference for endpoint details, required parameters, and authentication methods LoginRadius API reference documentation.

Common next steps

Once you have successfully made your first API call, several common next steps can further integrate LoginRadius into your application:

  1. Implement Login and Logout: Extend your application to handle user login, session management, and secure logout procedures using LoginRadius authentication APIs. This involves handling access tokens and refresh tokens.
  2. Configure Social Login: Set up integrations with popular social providers (e.g., Google, Facebook) to allow users to register and log in using their existing social accounts. This typically involves configuring provider applications and adding their credentials to the LoginRadius Admin Console.
  3. Enable Multi-Factor Authentication (MFA): Enhance security by implementing MFA options like SMS OTP, email OTP, or authenticator apps. This often requires enabling and configuring MFA methods within the LoginRadius Admin Console and integrating the corresponding API calls into your application.
  4. User Profile Management: Implement functionalities for users to view and update their profile information, change passwords, and manage their linked accounts.
  5. Webhooks and Event Handling: Set up webhooks to receive real-time notifications about user events (e.g., registration, login, profile updates), allowing your application to react to these changes.
  6. Customization of UI/UX: Customize the look and feel of LoginRadius hosted pages (e.g., registration, login, forgot password) or integrate their UI libraries to match your application's branding.
  7. Explore Advanced Features: Investigate features like Single Sign-On (SSO) for multiple applications, directory integrations, and advanced security settings.

Each of these steps builds upon the initial setup and leverages different parts of the LoginRadius API and Admin Console. Comprehensive documentation and specific guides are available for each feature LoginRadius developer documentation.

Troubleshooting the first call

Encountering issues during the initial API call is common. Here are some troubleshooting steps and potential causes for problems:

  • Incorrect API Key/Secret: Double-check that you are using the correct API Key and API Secret. Remember that the API Secret should only be used for server-side calls and should be kept confidential. Mismatched credentials or typos are frequent causes of authentication failures.
  • Missing Required Parameters: Ensure that all mandatory parameters for the specific API endpoint are included in your request payload. Refer to the LoginRadius API reference for precise requirements for each endpoint.
  • Invalid Request Format: Verify that your request body is correctly formatted (e.g., valid JSON for POST requests) and that the Content-Type header is set appropriately (e.g., application/json).
  • Network or Firewall Issues: Confirm that your development environment or server can access the LoginRadius API endpoints (e.g., api.loginradius.com). Proxy settings or firewall rules might block outbound requests.
  • SDK Initialization Errors: If using an SDK, ensure it's initialized correctly with your API Key and that the version is compatible with your application's environment. Check the SDK's specific documentation for initialization examples.
  • Error Messages: Pay close attention to the error messages returned by the API. LoginRadius typically provides descriptive error codes and messages that can help pinpoint the exact problem. For example, an Invalid API Key error clearly indicates a credential issue.
  • Console Logs: Utilize your browser's developer console (for client-side issues) or your server logs (for backend issues) to inspect the full request and response, including status codes and headers.
  • Rate Limiting: While unlikely for a first call, be aware of rate limits. Repeated failed attempts might trigger temporary blocking or throttling.
  • LoginRadius Admin Console: Check the 'Health' or 'Logs' section within your LoginRadius Admin Console, if available, for insights into API call failures or system status.

If issues persist, consult the LoginRadius documentation or reach out to their support channels with specific error messages and request details.