Getting Started

Prerequisites

• A valid email address
• Understanding of RESTful APIs
• HTTPS-enabled webhook endpoint (for notifications)

Quick Start (5 minutes)

Step 1: Register Your Account

curl -X POST <https://api.yativo.com/api/authentication/registration> \\
  -H "Content-Type: application/json" \\
  -d '{
    "username": "your_username",
    "email": "[email protected]"
  }'

Response:

{
  "success": true,
  "message": "User Registered Successfully!",
  "data": {
    "_id": "67db5f72ebea822c360d568d",
    "username": "your_username",
    "email": "[email protected]"
  },
  "token": "eyJhbGciOiJIUzI1NiIsInR..."
}

Save the token - you'll need it for the next step.

Step 2: Get Your API Key

curl -X GET <https://api.yativo.com/api/apikey/get-user-api-key> \\
  -H "Authorization: Bearer YOUR_REGISTRATION_TOKEN"

Response:

{
  "success": true,
  "apiKey": "yativo-abc123def456ghi789jkl012mno345pqr",
  "user_id": "67db5f72ebea822c360d568d",
  "created_at": "2025-10-01T12:00:00.000Z"
}

Step 3: Generate Bearer Token

curl -X POST <https://api.yativo.com/api/authentication/generate-key> \\
  -H "Content-Type: application/json" \\
  -d '{
    "email": "[email protected]",
    "api_key": "yativo-abc123def456ghi789jkl012mno345pqr"
  }'

Response:

{
  "status": true,
  "message": "Authentication successful!",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR...",
    "user_id": "67db5f72ebea822c360d568d"
  }
}

Use this token for all API requests: