Developer Portal

Orca SaaS API Documentation

Reliable and high-performance service infrastructure enabling businesses to integrate seamlessly with our platform. Built on REST architecture, communicating via HTTPS in JSON format.

Quick Start Test Sandbox
API Version 1.0 • GDPR Compliant

Basic Information

API Base URL

https://api.orcasaas.com/v1/

Data Format

  • Request: JSON
  • Response: JSON
  • Encoding: UTF-8

Protocol

  • All requests are only accepted via HTTPS.
  • Requests made via HTTP are automatically rejected.

Authentication

Orca SaaS API uses Bearer Token based authentication.

Authentication Header

Authorization: Bearer <API_KEY>

Obtaining API Key

API keys can be generated from the "Developer Settings" section in the Orca SaaS management panel.

Invalid/Expired Token Response

{
  "status": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired API token."
}

Error Codes

Code Description
200Success
201Record created
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
422Missing/Invalid parameter
500Server error

User Endpoints

GET /users/me

Retrieves user information.

Response:

{
  "id": "u_93812",
  "name": "John Doe",
  "email": "john@company.com",
  "role": "admin"
}
POST /users

Creates a new user.

Parameters:

{
  "name": "string",
  "email": "string",
  "role": "admin|manager|member"
}

Project Management Endpoints

GET /projects

Retrieves project list.

POST /projects

Creates a new project.

Example Body:

{
  "project_name": "Sales Optimization",
  "description": "Multi-country operations workflow."
}
GET /projects/{project_id}

Retrieves project details.

Data Analytics Endpoints

GET /analytics/report

Retrieves analytics report.

Parameters:

?project_id=<value>
?date_start=<value>
?date_end=<value>

Response:

{
  "project_id": "p_12345",
  "metrics": {
    "task_completion_rate": 92,
    "active_users": 312,
    "conversion_rate": 14.6
  }
}

Automation Endpoints

GET /automation/flows

Lists automation flows.

POST /automation/flows

Creates new flow.

Example:

{
  "flow_name": "Lead Sync",
  "trigger": "new_lead_created",
  "actions": [
    {
      "type": "send_email",
      "template_id": "t_5533"
    }
  ]
}

CRM Integration Endpoints

POST /crm/leads

Sends lead to CRM.

Example Submission:

{
  "lead_id": "l_9982",
  "crm": "salesforce",
  "fields": {
    "name": "Alex Morgan",
    "company": "Nova GmbH",
    "email": "alex@nova.com"
  }
}

Rate Limits

API rate limits are optimized considering the high traffic in Europe.

Plan Limit
Free1,000 requests / day
Pro20,000 requests / day
EnterpriseUnlimited

Security and GDPR Compliance

Orca SaaS API is developed in full compliance with GDPR.

Data minimization
Log encryption
Token lifetime
Regional server management (EU-based)
IP rate control
User data deletion mechanism

Webhooks

Webhook support is available for real-time notifications.

Supported Event Types

  • lead.created
  • task.completed
  • project.updated
  • integration.failed
  • user.invited

Sandbox Environment

Dedicated sandbox environment for developers to test:

https://sandbox.api.orcasaas.com/v1/

SDK and Integration Libraries

Ready-to-use integration packages:

Node.js SDK

Python SDK

PHP Client

Java REST Client

Zapier Connector Beta

Make.com Integration

Developer Support

You can reach our developer support team for any questions regarding API integration.

developers@orcasaas.com

Quick Access

API Status

All Systems Operational
Uptime 99.9%
Average Response 120ms