Authentication

​

Obtaining API Keys

1. Log in to the Admina dashboard
2. Select Settings from the top-right user settings menu
3. Choose API Keys in the left navigation menu
4. Click the Create New API Key button
5. Enter a name for the API key and set an expiration date if necessary
6. Click the Create button to generate the API key
7. Copy and save the displayed API key in a secure location

​

Adding Authentication to Requests

​

Header Format

X-API-Key: YOUR_API_KEY

​

Example with cURL

curl -H "X-API-Key: YOUR_API_KEY" \
  https://assist.i.moneyforward.com/api/v1/sessions

​

Example with JavaScript

const response = await fetch('https://assist.i.moneyforward.com/api/v1/sessions', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});

​

Security Best Practices

• Do not embed API keys in source code or client-side code
• Use environment variables or secret management systems to manage API keys
• Delete API keys that are no longer needed
• Consider rotating API keys regularly
• Monitor for API access from unexpected locations

​

Authentication Errors

{
  "ok": false,
  "error": "Missing or invalid API key"
}