API Authentication

Learn how to authenticate with the Syncaty API using JWT tokens or OAuth2 for third-party integrations.

Authentication Methods

Syncaty supports two authentication methods:

JWT Authentication

Obtaining a Token

Send a POST request to the login endpoint:

POST /auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "your-password"
}

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "email": "user@example.com",
    "name": "John Doe"
  }
}

Using the Token

Include the token in the Authorization header for all API requests:

GET /api/stores
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token Details

OAuth2 Authentication

OAuth2 is used for third-party integrations. Create an OAuth app in Syncaty to get your credentials.

Creating an OAuth App

1. Go to Settings → OAuth Apps
2. Click "Create New App"
3. Enter app name and redirect URI
4. Copy your Client ID and Client Secret

Authorization Flow

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&code=AUTHORIZATION_CODE
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET
&redirect_uri=YOUR_REDIRECT_URI

Token Response

{
  "access_token": "oauth_access_token_here",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "oauth_refresh_token_here",
  "scope": "stores:read customers:read"
}

Available Scopes

Error Responses

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "Insufficient permissions"
}