Skip to main content

API Reference Overview

ReUp provides a comprehensive REST API for integrating with our platform.

Base URL

Production: https://api.reup.com/v1
Staging: https://api-staging.reup.com/v1

Authentication

All API requests require authentication using JWT tokens.

Obtaining a Token

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

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

Response:

{
"access_token": "eyJhbGciOiJIUzI1...",
"refresh_token": "eyJhbGciOiJIUzI1...",
"token_type": "bearer",
"expires_in": 3600
}

Using the Token

Include the token in the Authorization header:

GET /api/v1/inventory
Authorization: Bearer eyJhbGciOiJIUzI1...

API Sections

Backend API

Frontend SDK

  • Hooks - React hooks reference
  • Types - TypeScript type definitions
  • Utilities - Helper functions

Interactive Documentation

For interactive API testing, visit:

Rate Limits

TierRequests/MinuteRequests/Day
Free601,000
Pro30010,000
EnterpriseUnlimitedUnlimited

Error Responses

All errors follow this format:

{
"error": {
"code": "INVALID_REQUEST",
"message": "Description of the error",
"details": {}
}
}

Common Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Invalid or expired token
FORBIDDEN403Insufficient permissions
NOT_FOUND404Resource not found
RATE_LIMITED429Too many requests
SERVER_ERROR500Internal server error

Versioning

The API is versioned via URL path (/v1/). We maintain backwards compatibility within major versions.

SDKs

Official SDKs coming soon:

  • Python SDK
  • Node.js SDK
  • TypeScript types (available now)

Webhooks

Configure webhooks at Settings > API > Webhooks

Supported events:

  • order.created
  • order.updated
  • inventory.changed
  • transfer.completed