REST API Dokumentation

GET /api/v1/status

Gibt API-Status und Informationen zum verwendeten API-Key zurück.

Request

curl -X GET "https://dev.jobriver.de/api/v1/status" \
  -H "X-API-Key: jrv_abc123..."

Response (200 OK)

{
  "success": true,
  "data": {
    "api_version": "v1",
    "status": "ok",
    "key": {
      "name": "Production API Key",
      "prefix": "jrv_abc1",
      "status": "active",
      "permissions": ["read", "create", "update", "delete"],
      "created_at": "2024-01-15T10:00:00Z",
      "expires_at": null
    },
    "company": {
      "id": 42,
      "name": "TechStartup GmbH",
      "slug": "techstartup-gmbh"
    },
    "limits": {
      "rate_limit": {
        "requests_per_minute": 60,
        "remaining": 58,
        "reset": 1707134520
      },
      "job_limit": {
        "limit": 100,
        "current_active_jobs": 23,
        "unlimited": false
      }
    },
    "usage": {
      "requests_total": 4523,
      "requests_today": 127,
      "jobs_created": 45,
      "last_request_at": "2024-02-05T14:30:00Z",
      "last_request_ip": "192.168.1.100"
    },
    "ip_whitelist": ["192.168.1.0/24"],
    "server_time": "2024-02-05T14:35:00+01:00"
  },
  "meta": {
    "rate_limit": {
      "limit": 60,
      "remaining": 58,
      "reset": 1707134520
    }
  }
}

GET /api/v1/jobs

Listet alle Jobs des Unternehmens mit Pagination und Filteroptionen.

Query Parameter

Request

curl -X GET "https://dev.jobriver.de/api/v1/jobs?page=1&per_page=10&is_active=true" \
  -H "X-API-Key: jrv_abc123..."

Response (200 OK)

{
  "success": true,
  "data": {
    "jobs": [
      {
        "id": 123,
        "slug": "senior-backend-developer",
        "title": "Senior Backend Developer",
        "description": "Wir suchen einen erfahrenen Backend Developer...",
        "requirements": "Mindestens 5 Jahre Erfahrung mit PHP...",
        "benefits": "Flexible Arbeitszeiten, Remote-Option...",
        "location": "Berlin, Germany",
        "location_type": "hybrid",
        "employment_type": "fulltime",
        "experience_level": "senior",
        "category": {
          "id": 5,
          "name": "Software Development",
          "slug": "software-development"
        },
        "salary": {
          "min": 65000,
          "max": 85000,
          "currency": "EUR"
        },
        "technologies": [
          {"id": 1, "name": "PHP", "slug": "php", "category": "backend"},
          {"id": 2, "name": "Laravel", "slug": "laravel", "category": "backend"},
          {"id": 3, "name": "MariaDB", "slug": "mariadb", "category": "database"}
        ],
        "apply_type": "internal",
        "apply_url": null,
        "apply_email": null,
        "is_featured": false,
        "is_active": true,
        "applications_count": 12,
        "start_date": "2024-03-01",
        "languages_required": ["Deutsch", "Englisch"],
        "soft_skills": ["Teamfähigkeit", "Kommunikation"],
        "published_at": "2024-02-01T10:00:00Z",
        "expires_at": null,
        "created_at": "2024-02-01T09:30:00Z",
        "updated_at": "2024-02-05T14:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total": 23,
      "total_pages": 3
    }
  },
  "meta": {
    "rate_limit": { "limit": 60, "remaining": 57, "reset": 1707134520 }
  }
}

GET /api/v1/jobs/{id}

Gibt einen einzelnen Job zurück.

Request

curl -X GET "https://dev.jobriver.de/api/v1/jobs/123" \
  -H "X-API-Key: jrv_abc123..."

Response

Einzelnes Job-Objekt (gleiche Struktur wie bei der Auflistung).

POST /api/v1/jobs

Erstellt einen neuen Job.

Pflichtfelder

Optionale Felder

Request

curl -X POST "https://dev.jobriver.de/api/v1/jobs" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: jrv_abc123..." \
  -d '{
    "title": "Senior Backend Developer",
    "description": "Wir suchen einen erfahrenen Backend Developer mit mindestens 5 Jahren Berufserfahrung in PHP. Sie werden an der Entwicklung unserer Kernplattform arbeiten und eng mit dem Frontend-Team zusammenarbeiten.",
    "location": "Berlin, Germany",
    "location_type": "hybrid",
    "employment_type": "fulltime",
    "experience_level": "senior",
    "category_id": 5,
    "salary_min": 65000,
    "salary_max": 85000,
    "technologies": [1, 2, 3],
    "apply_type": "internal",
    "start_date": "2024-03-15",
    "languages_required": ["Deutsch", "Englisch"],
    "soft_skills": ["Teamfähigkeit", "Kommunikation"],
    "is_active": true
  }'

Response (201 Created)

{
  "success": true,
  "data": {
    "id": 456,
    "slug": "senior-backend-developer-2",
    "title": "Senior Backend Developer",
    ...
  }
}

Validation Error (422)

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "details": {
      "errors": {
        "title": "Title must be at least 3 characters",
        "description": "Description must be at least 50 characters",
        "salary_min": "salary_min cannot be greater than salary_max"
      }
    }
  }
}

PUT /api/v1/jobs/{id}

Aktualisiert einen bestehenden Job. Partial Updates sind möglich - nur die übergebenen Felder werden aktualisiert.

Request

curl -X PUT "https://dev.jobriver.de/api/v1/jobs/123" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: jrv_abc123..." \
  -d '{
    "salary_min": 70000,
    "salary_max": 90000,
    "is_featured": true
  }'

Response (200 OK)

Gibt das aktualisierte Job-Objekt zurück.

DELETE /api/v1/jobs/{id}

Löscht einen Job permanent. Diese Aktion kann nicht rückgängig gemacht werden.

Request

curl -X DELETE "https://dev.jobriver.de/api/v1/jobs/123" \
  -H "X-API-Key: jrv_abc123..."

Response (200 OK)

{
  "success": true,
  "data": {
    "deleted": true,
    "job_id": 123
  }
}