​
Overview

The Jmpy.me API uses Bearer token authentication for all endpoints. You must include your API key in the Authorization header of every request. 
Authorization: Bearer YOUR_API_KEY

​
Getting Your API Key

1

Sign In

Log in to your Jmpy.me account at jmpy.me/login
2

Access Developer Settings

Navigate to Dashboard → API Keys or go directly to jmpy.me/dashboard/api-keys
3

Create API Key

Click Create New API Key, give it a descriptive name, and select the appropriate permissions
4

Copy and Store

Copy your API key immediately - it won’t be shown again for security reasons

​
Authentication Methods

Include your API key in the Authorization header: 
curl -X GET https://jmpy.me/api/v1/short-urls \
  -H "Authorization: Bearer your_api_key_here"

​
Query Parameter

For legacy support, you can also pass the API key as a query parameter: 
curl -X GET "https://jmpy.me/api/v1/short-urls?api_key=your_api_key_here"
Query parameter authentication is less secure and not recommended for production use. The API key may be logged in server access logs.

​
API Key Permissions

When creating an API key, you can configure the following permissions:
PermissionDescription
readRead access to all resources
writeCreate and update resources
deleteDelete resources
analyticsAccess to analytics endpoints

​
Security Best Practices

  • Never commit API keys to version control
  • Use environment variables to store keys
  • Don’t expose keys in client-side code
  • Create keys with minimum required permissions
  • Use different keys for different environments (dev, staging, production)
  • Rotate keys periodically
  • Check your API usage regularly in the dashboard
  • Set up alerts for unusual activity
  • Review access logs periodically

​
Error Responses

​
Missing Authentication

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key is required"
  }
}

​
Invalid API Key

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or has been revoked"
  }
}

​
Insufficient Permissions

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Your API key does not have permission to perform this action"
  }
}

​
Rate Limiting

API keys are subject to rate limits based on your plan. See Rate Limits for details.
Need higher rate limits? Upgrade your plan or contact us for enterprise options.

Quickstart

Get up and running with your first API call

Rate Limits

Understand API usage limits by plan

Error Handling

Handle API errors gracefully

API Overview

Explore all available API endpoints