أنشئ مشروعًا جديدًا عن طريق تحديد name الخاص به.

POST

/api/v1/projects

Authorization: {YOUR_ORGANIZATION_API_KEY}: يمكن العثور على المفتاح في ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

200: تُرسَل الاستجابة بصيغة JSON في النص

curl -X POST \
  https://openreplay.example.com/api/v1/projects/MyFirstProject \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'
  --data-raw '{
    "name": "MyFirstProject"
}'

{
  "data": {
    "projectKey": "QsLA07Oa5sqTfwnNaFwS",
    "name": "MyFirstProject",
    "gdpr": {
      "maskEmails": true,
      "sampleRate": 50,
      "maskNumbers": true,
      "defaultInputMode": "plain"
    }
  }
}

تُرجِع تفاصيل المشروع المحدد.

GET

/api/v1/projects/:projectKey

Authorization: {YOUR_ORGANIZATION_API_KEY}: يمكن العثور على المفتاح في ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

200: تُرسَل الاستجابة بصيغة JSON في النص

curl -X GET \
  https://openreplay.example.com/api/v1/projects/7ePSXFuQVidq9pqS6Xyn \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  }
}

تُرجِع قائمة المشاريع الموجودة.

GET

/api/v1/projects

Authorization: {YOUR_ORGANIZATION_API_KEY}: يمكن العثور على المفتاح في ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

200: تُرسَل الاستجابة بصيغة JSON في النص

curl -X GET \
  https://openreplay.example.com/api/v1/projects \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  },
  {
    "projectKey": "9cACFRuQVidq0sqS7Bny",
    "name": "MySecondProject"
  }
}