API Reference

Build powerful integrations with our REST API.

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY
GET/v1/projects

List all projects associated with your API key.

Parameters

pageintegerPage number for pagination
limitintegerNumber of items per page (max 100)

Response

{
  "data": [
    {
      "id": "prj_123abc",
      "name": "My SaaS Platform",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:22:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 5
  }
}

Example Request

curl https://api.bewaytech.com/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/v1/projects

Create a new project.

Parameters

namestringrequiredProject name
descriptionstringProject description
frameworkstringPreferred framework (react, vue, angular)

Response

{
  "id": "prj_456def",
  "name": "E-commerce Platform",
  "status": "pending",
  "created_at": "2024-01-22T09:15:00Z"
}

Example Request

curl -X POST https://api.bewaytech.com/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"E-commerce Platform","framework":"react"}'
GET/v1/deployments

List all deployments for a project.

Parameters

project_idstringrequiredProject ID
statusstringFilter by status (building, success, failed)

Response

{
  "data": [
    {
      "id": "dpl_789ghi",
      "project_id": "prj_123abc",
      "status": "success",
      "created_at": "2024-01-21T16:45:00Z",
      "completed_at": "2024-01-21T16:52:00Z",
      "url": "https://my-saas-platform.bewaytech.app"
    }
  ]
}

Example Request

curl "https://api.bewaytech.com/v1/deployments?project_id=prj_123abc" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/v1/deployments

Trigger a new deployment for a project.

Parameters

project_idstringrequiredProject ID to deploy
branchstringGit branch name (default: main)

Response

{
  "id": "dpl_101jkl",
  "project_id": "prj_123abc",
  "status": "building",
  "created_at": "2024-01-22T11:30:00Z"
}

Example Request

curl -X POST https://api.bewaytech.com/v1/deployments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"prj_123abc","branch":"main"}'
GET/v1/team/members

List all team members in your organization.

Parameters

rolestringFilter by role (admin, developer, viewer)

Response

{
  "data": [
    {
      "id": "usr_202mno",
      "name": "Sarah Johnson",
      "email": "sarah@company.com",
      "role": "admin",
      "joined_at": "2024-01-10T08:00:00Z"
    }
  ]
}

Example Request

curl https://api.bewaytech.com/v1/team/members \
  -H "Authorization: Bearer YOUR_API_KEY"
DELETE/v1/projects/:id

Delete a project and all associated resources.

Parameters

idstringrequiredProject ID to delete

Response

{
  "id": "prj_123abc",
  "status": "deleted",
  "deleted_at": "2024-01-22T12:00:00Z"
}

Example Request

curl -X DELETE https://api.bewaytech.com/v1/projects/prj_123abc \
  -H "Authorization: Bearer YOUR_API_KEY"

Rate Limits

API requests are rate-limited based on your subscription plan:

Starter

1,000

requests/hour

Growth

5,000

requests/hour

Scale

Unlimited

No rate limits