Skip to main content
This introduction applies to API versions v4 and above, where both API Key Authentication and User Login Authentication are supported. API Key Authentication remains fully compatible for backward support.

Authentication Methods

Access to the API supports two authentication methods:

Legacy Method: API Key Authentication

  1. Log in at Ricardoneud.com
  2. Navigate to Dashboard → API Keys
  3. Click the Create API Key button
  4. In the modal that appears:
    • Enter a descriptive name for your API key
    • Configure the desired permissions
    • Set the state to Production using the environment selector
  5. Click Generate
  6. Your API key is now created

Example UI:

API Key Creation UI

Usage

Use the API Key in the Authorization header of subsequent requests:
Authorization: Basic YOUR_API_KEY
This method remains fully supported and is compatible with all versions, including v3 and above.

Current Method (v3+): User Login Authentication

Don’t share your screen or take screenshots while your password is in the request body!
Starting from version 3, you can also authenticate using the User Login Endpoint:
POST https://api.ricardoneud.com/v{version_number}/user/login
A successful login returns a JSON response containing a secret token:
{
  "message": "Login successful",
  "userId": 123,
  "userEmail": "user@example.com",
  "secret": "UmljYXJkb05ldWQuQXBpQ29ubmVjdC0xYTJiM2M0ZDVlNmY3Zzho"
}
Use the returned secret token in subsequent API requests:
Authorization: Bearer YOUR_SECRET
For detailed request and response specifications of the login endpoint, refer to the respective endpoint documentation.

API Base URLs

EnvironmentBase URLCurrent Version
Productionhttps://api.ricardoneud.comv4
Use versioned endpoints for consistency:
https://api.ricardoneud.com/v4/...

Start Testing

All API endpoints can be tested directly within this documentation. You will benefit from:
  • Real-time response previews
  • Error handling simulation
  • WebSocket event testing (where supported)
I