API Authentication

How to authenticate with the SuitePortal API.

API Authentication

This documentation is currently being developed. Check back soon for complete content.

Authentication Methods

API Keys

Primary method for server-to-server integration.

Creating an API Key

Navigate to Settings > API Keys
Click Create API Key
Set permissions scope
Copy and store securely

Using an API Key

Include in Authorization header:

curl -H "Authorization: Bearer sk_live_your_api_key" \
  https://api.suiteportal.io/v1/transactions

Session Tokens

For browser-based applications using existing user sessions.

Security Best Practices

Never expose API keys in client-side code
Use environment variables
Rotate keys periodically
Use minimum required permissions
Monitor API key usage

Key Permissions

API keys can be scoped to specific permissions:

Scope	Access
`read:transactions`	Read transaction data
`read:entities`	Read entity data
`write:*`	Write access
`admin:*`	Administrative access

API Overview

Introduction to the SuitePortal REST API.

API Rate Limits

Understanding API rate limits and quotas.

On this page

API Authentication Authentication Methods API Keys Creating an API Key Using an API Key Session Tokens Security Best Practices Key Permissions Related