> This is part 1 of 2 of the full documentation (pages 1–100 of 151).
> The content is paginated: fetch every part to see all of it.
> Next part: https://developer.perculus.com/llms-full.txt/1
> Page index: https://developer.perculus.com/llms.txt
# Genel Bakış
Platformumuzdaki tüm fonksiyonları, CURL komutlarıyla veya tercih ettiğiniz programlama dilinde hazırlanan SDK'larımızı kullanarak API üzerinden gerçekleştirebilirsiniz.
Bu sayede, ihtiyaçlarınızı API ile otomatize ederek arayüze bağımlı kalmadan daha hızlı ve esnek bir şekilde hayata geçirebilirsiniz.
Aşağıda, bu doküman kapsamında yer alan servislerimizi görebilirsiniz:
* [Yetkilendirme](/perculus-api/services/yetkilendirme)
* [Oturum Yönetimi](/perculus-api/services/oturum-yonetimi)
* [Kullanıcı Yönetimi](/perculus-api/services/kullanici-yonetimi)
* [Katılımcı Yönetimi](/perculus-api/services/katilimci-yonetimi)
* [Raporlar](/perculus-api/services/raporlar)
Bu dokümantasyon içerisinde, yukarıda belirtilen servislerle ilgili endpoint'ler, SDK kullanımı, örnek kodlar ve request/response yapılarını bulabileceksiniz.
### Jump right in
# Hızlı Başlangıç
İlk isteğinizi atabilmek için aşağıdaki adımları takip etmeniz gerekmektedir:
* [Hesap oluşturma](#hesap-olusturma)
* [API Kullanıcısı oluşturma](#api-kullanicisi-olusturma)
* [Yetkilendirme](#yetkilendirme)
* [İlk istek ](#ilk-istek):rocket:
### Hesap Oluşturma
İlk olarak [Perculus](https://perculus.com) platformumuzdan bir hesap açmanız gerekmektedir. Hesabınız var ise bu adımı atlayabilirsiniz.
{% hint style="warning" %}
Hesap ayarlarınızda bulunan "Unvan" alanını dokuman içerisinde domain olarak isimlendireceğiz, bu alanı istek atarken kullacağımız için bu alanı not etmeniz önemlidir.
{% endhint %}
### API Kullanıcısı Oluşturma
Daha önce oluşturmuş olduğunuz hesabınıza giriş yapıp PerculusAPI'yi kullanabilmek için bir API kullanıcısı oluşturmanız gerekmektedir.
Bu işlem için aşağıdaki adımları takip edebilirsiniz;
1. **Perculus platformuna** [**buradan**](https://perculus.com/tr/login) **giriş yapınız.**
2. **Giriş yaptıktan sonra "Kullanıcılar" bölümünden "Yeni Kullanıcı" butonuna tıklayarak yeni kullanıcı ekleme alanını açınız.**
{% hint style="danger" %}
Bu aşamada kullanıcı oluşturma formunda email ve şifre alanlarına yazacağınız bilgileri API'ye istek atarken kullanacağız. Bu nedenle bu kullanıcının ***silinmemesi*** gerektiğini unutmayın.
{% endhint %}
### Yetkilendirme
API'ye isteğimizi atmadan önce, daha önce oluşturduğumuz API kullanıcımız için bir ACCESS\_TOKEN almamız gerekmektedir.
ACCESS\_TOKEN alabilmek için atacağımız istekte ACCOUNT\_ID verisine ihtiyacımız olacaktır.
{% hint style="warning" %}
ACCOUNT\_ID verisi için sistem yöneticiniz ile iletişime geçip hesabınıza ait olan "ACCOUNT\_ID" verisine sahip olabilirsiniz
{% endhint %}
Son olarak ACCESS\_TOKEN almak için ihtiyacınız olan parametreler ile beraber örnek bir CURL yapısını aşağıda görebilirsiniz:
* DOMAIN: Yukarda belirtilen "Unvan" alanındaki veri
* EMAIL: API için oluşturduğumuz kullanıcının email adresi
* PASSWORD: API için oluşturduğumuz kullanıcının şifresi
* ACCOUNT\_ID
```bash
curl --location 'https:///connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=' \
--data-urlencode 'password=' \
--data-urlencode 'client_id=api' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'account_id='
```
Parametrelerinizi doğru bir şekilde attığınızda aşağıdaki gibi bir response gelecektir.
```json
{
"access_token": "",
"expires_in": 36000,
"token_type": "Bearer",
"scope": "api"
}
```
{% hint style="danger" %}
**ACCESS\_TOKEN daha sonra kullanılacak tüm servislerde gerekecektir. Bu nedenle ACCESS\_TOKEN'inizi güvenli bir yerde saklamayı unutmayın.**
{% endhint %}
### İlk İstek :rocket:
GroupsAPI'ye ilk isteğinizi atabilmeniz için gerekli tüm adımları yukarıda belirttik ve artık ilk isteğinizi atmak için hazırsınız.
İstek atarken CURL yöntemini kullanacağız. Bu işlemi sistemdeki tüm oturumlarınızı listeleyebileceğiniz `/session` endpointi ile örnekleyeceğiz.
İstek atabilmek için ihtiyaçlarımız:
* Domain
* Access Token
Şimdi örnek servisimiz olan oturum listesi için CURL yapısını görebilirsiniz:
```bash
curl --location 'https:///xapi/session' \
--header 'Authorization: Bearer '
```
Yukardaki örnek isteği attığınızda response olarak tüm oturumlarınızı listeleyebileceksiniz.
Bu sayede ilk isteğimizi atmayı başardık :rocket:
# Yetkilendirme
GroupsApi üzerinden servislere gönderilecek tüm isteklerde "HEADER" alanına Authentication key olarak Bearer token eklenmelidir.
Bearer token olarak kullanacağımız ACCESS\_TOKEN'i oluşturmak için gerekli parametreleri aşağıda görebilirsiniz:
* DOMAIN: QuickStart alanında belirtilen "Unvan"
* EMAIL: API için oluşturduğumuz kullanıcının email adresi
* PASSWORD: API için oluşturduğumuz kullanıcının şifresi
* ACCOUNT\_ID
{% hint style="warning" %}
ACCOUNT\_ID verisi için sistem yöneticiniz ile iletişime geçip hesabınıza ait olan "ACCOUNT\_ID" verisine sahip olabilirsiniz
{% endhint %}
Tüm parametrelerimiz hazır ise, aşağıdaki alanda bulunan örneği uygulayarak ACCESS\_TOKEN verisine erişebilirsiniz.
{% tabs %}
{% tab title="CURL" %}
Aşağıdaki CURL isteğini attıktan sonra response olarak ACCESS\_TOKEN gelecektir.
```bash
curl --location 'https:///connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=' \
--data-urlencode 'password=' \
--data-urlencode 'client_id=api' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'account_id='
```
Aşağıda örnek response modelini görebilirsiniz:
```json
{
"access_token": "",
"expires_in": 36000,
"token_type": "Bearer",
"scope": "api"
}
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra ilgili kod bloğuna SDK import edilmelidir:
```python
from perculus_sdk.client import APIClient
```
Son olarak; parametreleriniz ile ***"set\_credentials"*** metodunu kullanarak authentication işlemini tamamlayabilirsiniz.
```python
# API client
client = APIClient()
# Set your domain
client.set_domain("")
# Set your credentials
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
```
Bu akış sonrasında SDK'da bulunan her bir servis için tekrar tekrar yetkilendirme işlemi yapmadan diğer metodları istediğiniz gibi kullanabilirsiniz.
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
{% hint style="danger" %}
**ACCESS\_TOKEN daha sonra kullanılacak tüm servislerde gerekecektir. Bu nedenle ACCESS\_TOKEN'inizi güvenli bir yerde saklamayı unutmayın.**
{% endhint %}
# Oturum Yönetimi
# Oturum Listesi
Bu alan, tüm oturumlarınızın listesini GroupsAPI ile nasıl çekebileceğinizi gösterir.
Aşağıdaki alanda oturum listesini nasıl çekebileceğinizi gösteren örnek kod bloğunu görebilirsiniz:
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location 'https:///xapi/session' \
--header 'Authorization: Bearer ' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde oturumlarınızı listeleyebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#List sessions
sessions = client.sessions.list_sessions()
print(sessions)
```
İstek sonrasında aşağıdaki örnek response modelini görebilirsiniz:
```json
[
{
"session_id": "",
"name": "test session",
"description": "",
"tags": "",
"start_date": "2024-09-25T14:00:25.699+03:00",
"timezone": "Europe/Istanbul",
"duration": 10,
"lang": "tr-TR",
"status": 1,
"replay_status": 0,
"options": {
"allow_rating": true,
"preparation_time": 15,
"session_duration": 60,
"chat": {
"offMessageModule": false,
"offGeneralMsging": false,
"offGeneralMsgLimitForUser": false,
"offSpecialMsging": false,
"offSpecialMsgToAdmin": false,
"offSpecialMsgToUser": false,
"offNewMsgSound": false,
"offClearForReplay": false,
"onNewMsgSoundInAll": false,
"onNewMsgNotifyInAll": false
},
"duration": {
"allowExtendTime": true,
"useRemainingTime": false
},
"allow_users_stream_self_cam_mic": true,
"hide_user_streams": false,
"enable_attendance_check": false,
"enable_simultaneous_interpretation": false,
"enable_simultaneous_interpretation_for_users": false,
"start_active": false,
"return_url": ""
},
"creation_date": "2024-08-08T10:05:58.663361+00:00",
"updating_date": null
}
]
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
{% hint style="warning" %}
Bu istek ile servisten gelen response'da bulunan listedeki herhangi bir oturumda işlem yapmak isterseniz ilgili oturumun ***SESSION\_ID*** verisini güvenli bir şekilde saklamanız gerekmektedir.
{% endhint %}
# Oturum Detay
Bu alan, herhangi bir oturumunuzun detayını GroupsAPI ile nasıl çekebileceğinizi gösterir.
Aşağıdaki alanda oturum detayını nasıl çekebileceğinizi gösteren örnek kod bloğunu görebilirsiniz:
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location 'https:///xapi/session/' \
--header 'Authorization: Bearer ' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde oturumlarınızı listeleyebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#List sessions
session = client.sessions.get_session("")
print(session)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
İstek sonrasında aşağıdaki örnek response modelini görebilirsiniz:
```json
{
"session_id": "",
"name": "test session",
"description": "",
"tags": "",
"start_date": "2024-09-25T14:00:25.699+03:00",
"timezone": "Europe/Istanbul",
"duration": 10,
"lang": "tr-TR",
"status": 1,
"replay_status": 0,
"options": {
"allow_rating": true,
"preparation_time": 15,
"session_duration": 60,
"chat": {
"offMessageModule": false,
"offGeneralMsging": false,
"offGeneralMsgLimitForUser": false,
"offSpecialMsging": false,
"offSpecialMsgToAdmin": false,
"offSpecialMsgToUser": false,
"offNewMsgSound": false,
"offClearForReplay": false,
"onNewMsgSoundInAll": false,
"onNewMsgNotifyInAll": false
},
"duration": {
"allowExtendTime": true,
"useRemainingTime": false
},
"allow_users_stream_self_cam_mic": true,
"hide_user_streams": false,
"enable_attendance_check": false,
"enable_simultaneous_interpretation": false,
"enable_simultaneous_interpretation_for_users": false,
"start_active": false,
"return_url": ""
},
"creation_date": "2024-08-08T10:05:58.663361+00:00",
"updating_date": null
}
```
# Oturum Oluşturma
Bu alan, bir oturumu GroupsAPI ile nasıl oluşturabileceğiniz gösterir.
Aşağıdaki listede bir oturum oluştururken ekleyebileceğiniz tüm parametrelerin listesini görebilirsiniz:
Parametre
Tip
Zorunlu
Açıklama
name
string
Evet
Oturum adı
description
string
Hayır
Açıklama
tags
string
Hayır
start_date
datetime(ISO 8601 )
Evet
Başlangıç tarihi
duration
integer(min: 5)
Evet
Oturum süresi
lang
string(IETF language tag)
Hayır
status
integer
Hayır
allow_recording
bool
no
Oturumun kayıt edilip edilmeyeceğini belirler. Varsayılan değeri 'true'.
{% hint style="danger" %}
İlgili katılımcının ilgili oturumdaki ayarları ile ilgili bir düzenleme yapacak olursanız, yukarıda gördüğünüz response içerisinde bulunan"***ATTENDANCE\_CODE"*** verisi ile işlem yapmanız gerekecektir. Bu nedenle bu veriyi güvenli bir şekilde saklanız gerekmektedir.
{% endhint %}
:red\_circle: Response içerisinde approved ve rejected olarak iki obje göreceksiniz, bunların detaylarını aşağıda görebilirsiniz:
* approved:
* Katılımcı olarak eklenmeye çalışılan kullanıcılardan başarılı bir şekilde eklene kayıtları listeler.
* rejected:
* Katılımcı olarak eklenmeye çalışılan kullanıcılardan başarılı bir şekilde eklenemeyen kayıtları hata kodları ve hata mesajları ile birlikte listeler, aşağıda hatalı eklenmeye çalışılan bir kaydın response'unu görebilirsiniz
```json
{
"approved": [],
"rejected": [
{
"model": null,
"state": {
"code": 10,
"details": "Object reference not set to an instance of an object."
}
}
]
}
```
[^1]: İlgili katılımcının, ilgili oturumdaki kimlik numarası anlamına gelir.
# Katılımcı Güncelleme
Bu alan, GroupsAPI ile bir oturumadaki katılımcınızı güncellemenin yöntemini gösterir.
Bir oturumda bulunan bir katılımcınızın verilerini iki farklı parametre ile güncelleyebilirsiniz:
* [ATTENDANCE\_CODE](#attendance_code-parametresi-ile-katilimci-guncelleme)
* [EMAIL](#email-parametresi-ile-katilimci-guncelleme)
### ATTENDANCE\_CODE Parametresi ile Katılımcı Güncelleme
{% hint style="warning" %}
Bir oturumdaki katılımcınızı güncelleyebilmek için ilgili oturumun **SESSION\_ID** verisi ve ilgili kullanıcının katılımcı kimlik numarası olan **ATTENDANCE\_CODE** verilerine ihtiyacınız olacaktır.
{% endhint %}
Aşağıda listede güncellenebilecek parametreleri görebilirsiniz:
| Parameters | Tip | Açıklama |
| ---------- | ------ | -------------------------------------- |
| name | string | |
| surname | string | |
| email | string | |
| role | string |
a=Admin u=User e=Öğretmen
|
| mobile | string | |
| avatar | string | |
A**şağıdaki örnekte bir oturumdaki katılımcınızı ATTENDANCE\_CODE parametresi ile güncellemenin yöntemini görebilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request PUT 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
"name": "test",
"surname": "surname"
"role": "u"
}'
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcılarınızı güncelleyebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#Update an Attendee by ATTENDANCE_CODE
attendee = client.attendees.update_by_attendance_code(
session_id="",
attendance_code="",
attendee={
"name": "test",
"surname": "surname"
"role": "u"
}
)
print(attendee)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
### EMAIL Parametresi ile Katılımcı Güncelleme
{% hint style="warning" %}
Bir oturumdaki katılımcınızı **EMAIL** ile güncelleyebilmek için ilgili oturumun **SESSION\_ID** verisi ve ilgili kullanıcının **EMAIL** verilerine ihtiyacınız olacaktır.
{% endhint %}
Aşağıda listede güncellenebilecek parametreleri görebilirsiniz:
| Parameters | Tip | Açıklama |
| ---------- | ------ | -------------------------------------- |
| name | string | |
| surname | string | |
| email | string | |
| role | string |
a=Admin u=User e=Öğretmen
|
| mobile | string | |
| avatar | string | |
A**şağıdaki örnekte bir oturumdaki katılımcınızı EMAIL parametresi ile güncellemenin yöntemini görebilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request PUT 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
"name": "test",
"surname": "surname"
"role": "u"
}'
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcılarınızı güncelleyebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#Update an Attendee by EMAIL
attendee = client.attendees.update_by_email(
session_id="",
email="",
attendee={
"name": "test",
"surname": "surname"
"role": "u"
}
)
print(attendee)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
# Katılımcı Filtreleme
Bu alan, GroupsAPI ile bir oturumadaki katılımcılarınızı filtrelemenin yöntemini gösterir.
Bir oturumda bulunan katılımcılarınızı 3 farklı şekilde ile filtreleyebilirsiniz:
* [ATTENDANCE\_CODE ile](#attendance_code-parametresi-ile-katilimci-guncelleme)
* [EMAIL ile](#email-parametresi-ile-katilimci-guncelleme)
* [Katılımcı bilgileri ile](#katilimci-bilgileri-ile-filtreleme)
### ATTENDANCE\_CODE Parametresi ile Katılımcı Filtreleme
{% hint style="warning" %}
Bir oturumdaki katılımcınızın verilerine ulaşabilmek için ilgili oturumun **SESSION\_ID** verisi ve ilgili kullanıcının katılımcı kimlik numarası olan **ATTENDANCE\_CODE** verilerine ihtiyacınız olacaktır.
{% endhint %}
A**şağıdaki örnekte bir oturumdaki katılımcınızın verilerine ATTENDANCE\_CODE parametresi ile erişmenin yöntemini görebilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request GET 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcınızın verilerine erişebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#Get the attandee by ATTENDANCE_CODE
attendee = client.attendees.get_by_attendance_code(
session_id="",
attendance_code=""
)
print(attendee)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
### EMAIL Parametresi ile Katılımcı Filtreleme
{% hint style="warning" %}
Bir oturumdaki katılımcınızın verilerine **EMAIL** parametresi ile erişebilmek için ilgili oturumun **SESSION\_ID** verisi ve ilgili kullanıcının **EMAIL** verilerine ihtiyacınız olacaktır.
{% endhint %}
A**şağıdaki örnekte bir oturumdaki katılımcınızın verilerine EMAIL parametresi ile erişmenin yöntemini görebilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request GET 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcınızın verilerine erişebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#Get the attandee by EMAIL
attendee = client.attendees.get_by_email(
session_id="",
email=""
)
print(attendee)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
### Katılımcı Bilgileri ile Filtreleme
Aşağıdaki alanda filtreme işleminde kullanabileceğiniz tüm parametrelerin listesini görebilirsiniz:
| Parametre | Tip |
| ---------------- | ------- |
| user\_id | string |
| attendance\_code | string |
| name | string |
| surname | string |
| email | string |
| role | string |
| mobile | string |
| page\_size | integer |
| page\_number | integer |
| | |
**Tüm parametrelerden sonra aşağıdaki şekilde parametre olarak SESSION\_ID vererek katılımcı filtreleme işlemi yapabilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request GET 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: x-www-form-urlencoded' \
--data-urlencode 'name=john' \
--data-urlencode 'surname=doe'
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcınızı filtreleyebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#Filter Attendees
attendees = client.attendees.search_attendees(
session_id="",
params={
"name": "test name",
"role": "u"
}
)
print(attendees)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
# Katılımcı Silme
Bu alan, GroupsAPI ile bir oturumadaki katılımcılarınızı silmenin yöntemini gösterir.
Bir oturumda bulunan katılımcılarınızı 3 farklı parametre ile silebilirsiniz:
* ATTENDANCE\_CODE
* USER\_ID
* EMAIL
A**şağıdaki örnekte bir oturumdaki katılımcınızın silmenin yöntemini görebilirsiniz:**
{% tabs %}
{% tab title="CURL" %}
**ATTENDANCE\_CODE parametresi ile silme işlemi**
```bash
curl --location --request DELETE 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
**USER\_ID parametresi ile silme işlemi**
```bash
curl --location --request DELETE 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
**EMAIL parametresi ile silme işlemi**
```bash
curl --location --request DELETE 'https:///xapi/session//attendee/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
İlk olarak Python SDK'sı yüklenmelidir:
```bash
pip install perculus-sdk
```
SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde katılımcılarınızı silebilirsiniz:
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
# Set your domain (if you haven't set it before)
client.set_domain("")
# Set your credentials(if you haven't set it before)
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
#DELETE the attandee by ATTENDANCE_CODE
client.attendees.delete_by_attendance_code_or_user_id(
session_id="",
attendance_code_or_user_id=""
)
#DELETE the attandee by USER_ID
client.attendees.delete_by_attendance_code_or_user_id(
session_id="",
attendance_code_or_user_id=""
)
#DELETE the attandee by EMAIL
client.attendees.delete_by_email(
session_id="",
email=""
)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="GO" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
# Raporlar
# Kurulum Hataları
# Hata Kodları
# Zaman Dilimleri
Groups'a gönderilecek zaman dilimleri parametreleri string olmalıdır ve İngilizce isimlendirme kullanılarak [IANA TZ](https://data.iana.org/time-zones/tzdb-2024b/zone1970.tab) standartını takip etmelidir. Aşağıda kabul edilen zaman dilimlerini görebilirsiniz:
```json
[
"Pacific/Niue",
"Pacific/Midway",
"Pacific/Pago_Pago",
"Pacific/Rarotonga",
"America/Adak",
"Pacific/Honolulu",
"Pacific/Tahiti",
"Pacific/Marquesas",
"America/Anchorage",
"America/Juneau",
"America/Metlakatla",
"America/Nome",
"America/Sitka",
"America/Yakutat",
"Pacific/Gambier",
"America/Los_Angeles",
"America/Tijuana",
"America/Vancouver",
"Pacific/Pitcairn",
"America/Hermosillo",
"America/Mazatlan",
"America/Boise",
"America/Cambridge_Bay",
"America/Ciudad_Juarez",
"America/Creston",
"America/Dawson_Creek",
"America/Denver",
"America/Edmonton",
"America/Fort_Nelson",
"America/Inuvik",
"America/Phoenix",
"America/Dawson",
"America/Whitehorse",
"America/Bahia_Banderas",
"America/Belize",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/El_Salvador",
"America/Guatemala",
"America/Indiana/Knox",
"America/Managua",
"America/Matamoros",
"America/Menominee",
"America/Mexico_City",
"America/Monterrey",
"America/Merida",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Rankin_Inlet",
"America/Regina",
"America/Resolute",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Indiana/Tell_City",
"America/Winnipeg",
"Pacific/Easter",
"Pacific/Galapagos",
"America/Eirunepe",
"America/Rio_Branco",
"America/Bogota",
"America/Havana",
"America/Atikokan",
"America/Cancun",
"America/Cayman",
"America/Detroit",
"America/Grand_Turk",
"America/Indiana/Indianapolis",
"America/Iqaluit",
"America/Jamaica",
"America/Kentucky/Louisville",
"America/Indiana/Marengo",
"America/Kentucky/Monticello",
"America/Nassau",
"America/New_York",
"America/Panama",
"America/Indiana/Petersburg",
"America/Port-au-Prince",
"America/Toronto",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Guayaquil",
"America/Lima",
"America/Boa_Vista",
"America/Campo_Grande",
"America/Cuiaba",
"America/Manaus",
"America/Porto_Velho",
"America/Anguilla",
"America/Antigua",
"America/Aruba",
"America/Barbados",
"Atlantic/Bermuda",
"America/Blanc-Sablon",
"America/Curacao",
"America/Dominica",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grenada",
"America/Guadeloupe",
"America/Halifax",
"America/Kralendijk",
"America/Lower_Princes",
"America/Marigot",
"America/Martinique",
"America/Moncton",
"America/Montserrat",
"America/Port_of_Spain",
"America/Puerto_Rico",
"America/Santo_Domingo",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Thule",
"America/Tortola",
"America/La_Paz",
"America/Santiago",
"America/Guyana",
"America/Asuncion",
"America/Caracas",
"America/St_Johns",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Araguaina",
"America/Bahia",
"America/Belem",
"America/Fortaleza",
"America/Maceio",
"America/Recife",
"America/Santarem",
"America/Sao_Paulo",
"Atlantic/Stanley",
"America/Cayenne",
"Antarctica/Palmer",
"America/Punta_Arenas",
"Antarctica/Rothera",
"America/Miquelon",
"America/Paramaribo",
"America/Montevideo",
"America/Noronha",
"America/Nuuk",
"Atlantic/South_Georgia",
"Atlantic/Azores",
"Atlantic/Cape_Verde",
"America/Scoresbysund",
"UTC",
"Africa/Ouagadougou",
"Africa/Abidjan",
"America/Danmarkshavn",
"Africa/Banjul",
"Africa/Accra",
"Europe/Guernsey",
"Africa/Conakry",
"Africa/Bissau",
"Atlantic/Reykjavik",
"Europe/Dublin",
"Europe/Isle_of_Man",
"Europe/Jersey",
"Africa/Monrovia",
"Africa/Bamako",
"Africa/Nouakchott",
"Africa/Casablanca",
"Africa/Dakar",
"Africa/Freetown",
"Atlantic/St_Helena",
"Africa/Sao_Tome",
"Africa/Lome",
"Antarctica/Troll",
"Europe/London",
"Atlantic/Canary",
"Atlantic/Faroe",
"Europe/Lisbon",
"Atlantic/Madeira",
"Africa/El_Aaiun",
"Africa/Algiers",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Budapest",
"Europe/Busingen",
"Africa/Ceuta",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Ljubljana",
"Arctic/Longyearbyen",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Monaco",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Rome",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Stockholm",
"Europe/Tirane",
"Africa/Tunis",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Porto-Novo",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Juba",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Maputo",
"Africa/Windhoek",
"Europe/Athens",
"Asia/Beirut",
"Europe/Bucharest",
"Africa/Cairo",
"Europe/Chisinau",
"Asia/Gaza",
"Asia/Hebron",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kyiv",
"Europe/Mariehamn",
"Asia/Nicosia",
"Europe/Riga",
"Europe/Sofia",
"Europe/Tallinn",
"Africa/Tripoli",
"Europe/Vilnius",
"Asia/Famagusta",
"Asia/Jerusalem",
"Africa/Johannesburg",
"Africa/Maseru",
"Africa/Mbabane",
"Asia/Aden",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Kuwait",
"Asia/Qatar",
"Asia/Riyadh",
"Europe/Minsk",
"Africa/Addis_Ababa",
"Indian/Antananarivo",
"Africa/Asmara",
"Indian/Comoro",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Indian/Mayotte",
"Africa/Mogadishu",
"Africa/Nairobi",
"Asia/Amman",
"Europe/Kirov",
"Europe/Moscow",
"Europe/Simferopol",
"Antarctica/Syowa",
"Asia/Damascus",
"Europe/Istanbul",
"Europe/Volgograd",
"Asia/Tehran",
"Asia/Yerevan",
"Europe/Astrakhan",
"Asia/Baku",
"Asia/Tbilisi",
"Asia/Dubai",
"Asia/Muscat",
"Indian/Mauritius",
"Indian/Reunion",
"Europe/Samara",
"Europe/Saratov",
"Indian/Mahe",
"Europe/Ulyanovsk",
"Asia/Kabul",
"Indian/Kerguelen",
"Indian/Maldives",
"Antarctica/Mawson",
"Asia/Karachi",
"Asia/Dushanbe",
"Asia/Ashgabat",
"Asia/Samarkand",
"Asia/Tashkent",
"Antarctica/Vostok",
"Asia/Almaty",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Atyrau",
"Asia/Qostanay",
"Asia/Oral",
"Asia/Qyzylorda",
"Asia/Yekaterinburg",
"Asia/Colombo",
"Asia/Kolkata",
"Asia/Kathmandu",
"Asia/Dhaka",
"Asia/Thimphu",
"Indian/Chagos",
"Asia/Bishkek",
"Asia/Omsk",
"Asia/Urumqi",
"Indian/Cocos",
"Asia/Yangon",
"Asia/Barnaul",
"Indian/Christmas",
"Antarctica/Davis",
"Asia/Hovd",
"Asia/Bangkok",
"Asia/Ho_Chi_Minh",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Krasnoyarsk",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Tomsk",
"Asia/Jakarta",
"Asia/Pontianak",
"Antarctica/Casey",
"Australia/Perth",
"Asia/Brunei",
"Asia/Makassar",
"Asia/Macau",
"Asia/Shanghai",
"Asia/Hong_Kong",
"Asia/Irkutsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Manila",
"Asia/Singapore",
"Asia/Taipei",
"Asia/Ulaanbaatar",
"Asia/Choibalsan",
"Australia/Eucla",
"Asia/Dili",
"Asia/Jayapura",
"Asia/Tokyo",
"Asia/Pyongyang",
"Asia/Seoul",
"Pacific/Palau",
"Asia/Yakutsk",
"Asia/Chita",
"Asia/Khandyga",
"Australia/Adelaide",
"Australia/Broken_Hill",
"Australia/Darwin",
"Pacific/Guam",
"Pacific/Saipan",
"Pacific/Chuuk",
"Antarctica/DumontDUrville",
"Australia/Brisbane",
"Australia/Hobart",
"Australia/Lindeman",
"Antarctica/Macquarie",
"Australia/Melbourne",
"Australia/Sydney",
"Pacific/Port_Moresby",
"Asia/Vladivostok",
"Asia/Ust-Nera",
"Australia/Lord_Howe",
"Pacific/Bougainville",
"Pacific/Kosrae",
"Asia/Magadan",
"Pacific/Noumea",
"Pacific/Norfolk",
"Pacific/Pohnpei",
"Asia/Sakhalin",
"Pacific/Guadalcanal",
"Asia/Srednekolymsk",
"Pacific/Efate",
"Asia/Anadyr",
"Pacific/Fiji",
"Pacific/Tarawa",
"Pacific/Majuro",
"Pacific/Kwajalein",
"Pacific/Nauru",
"Pacific/Auckland",
"Antarctica/McMurdo",
"Asia/Kamchatka",
"Pacific/Funafuti",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Chatham",
"Pacific/Kanton",
"Pacific/Apia",
"Pacific/Fakaofo",
"Pacific/Tongatapu",
"Pacific/Kiritimati"
]
```
# Overview
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
You can integrate Groups into your platform or application with the help of our REST API. It allows you to carry out most of the functions that can be performed on Groups, such as managing sessions and users and creating reports.
The API can be utilized in two ways:
* Direct access: You can directly call the API endpoints. We provide sample [cURL](https://curl.se) commands throughout the documentation.
* Software development kits (SDKs): Currently, we have SDKs for C# and Python. We plan to release SDKs for Go and Node.Js soon.
The documentation covers the following services in detail and provides information about the API endpoints and using SDKs with sample code snippets.
* [Authorization](/services/authorization)
* [Session Management](/services/session-management)
* [User Management](/services/user-management)
* [Participant Management](/services/participant-management)
* [Reports](/services/reports)
* [Webhooks](/miscellaneous/webhooks)
### Jump right in
# Quick Start
In order to make your first request, you must follow the steps below:
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
* [Creating an Account](#creating-an-account)
* [Creating an API User](#creating-api-user)
* [Authorization](#authorization)
* [First Request](#first-request)
### Creating an Account
Firstly, you need to open an account on [Perculus](https://perculus.com). If you have an account, you can skip this step.
{% hint style="warning" %}
We will name the ‘Account Title’ field in your account settings as a domain in the document, and it is essential to note this field as we will use it when sending requests.
{% endhint %}
### Creating API User
To use the Groups API, you need to create an API user. You can follow the steps below for this process;
1. **Login to your** Groups **account from** [**here**](https://perculus.com/login)
1. **After logging in, click on the ‘New User’ button in the ‘Users’ section to open the new user creation screen.**
{% hint style="danger" %}
At this stage, we will use the information you will write in the email and password fields in the user creation form when sending requests to the API. Therefore, remember that this user **should not be deleted.**
{% endhint %}
### Authorization
Please follow steps that is in [Authorization](/services/authorization) section.
### First Request :rocket:
We have outlined all the steps necessary to make your first request to GroupsAPI above. You are now ready to make your first request.
We will use the CURL method to make a request. We will illustrate this with the `/session` endpoint where you can list all your sessions on the system.
Requirements
* Domain
* Access Token
For our example service, session list, you can now see the CURL structure:
```bash
curl --location 'https:///xapi/session' \
--header 'Authorization: Bearer '
```
You can list all your sessions in the response when you send the sample request above.
It's that easy to send requests in Groups. :rocket:
# Authorization
This page describes how to authenticate your requests to Groups API
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
{% hint style="info" %}
Bearer token must be added as Authentication key in the “HEADER” field for all requests to be sent to PerculusAPI.
{% endhint %}
Below are the parameters required to create ACCESS\_TOKEN. This is the token we will use as the Bearer:
* DOMAIN: The subdomain of Perculus that is used to access your Panel
* ACCESS\_KEY: The email address of the user we created for the API
* SECRET\_KEY: The password of the user we created for the API
* ACCOUNT\_ID: The GUID of your account
{% hint style="danger" %}
For **ACCOUNT\_ID** data, you can contact your customer success manager and get the **‘ACCOUNT\_ID**’ belonging to your account.
{% endhint %}
{% hint style="info" %}
All of these data can be collected from your environment variables as well. Just suffix each variable with `PERCULUS_` , and SDKs will try to collect those information.
{% endhint %}
Use the following example to access ACCESS\_TOKEN data.
{% tabs %}
{% tab title="CURL" %}
After sending the following CURL request, ACCESS\_TOKEN will be returned as the response.
```bash
curl --location --request POST 'https:///connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=' \
--data-urlencode 'password=' \
--data-urlencode 'client_id=api' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'account_id='
```
Below you can see a sample response model:
```json
{
"access_token": "",
"expires_in": 36000,
"token_type": "Bearer",
"scope": "api"
}
```
{% endtab %}
{% tab title="Python" %}
The Python SDK must be installed first:
```bash
pip install perculus-sdk
```
The SDK should be imported into the appropriate code block after ensuring that the SDK is installed:
```python
from perculus_sdk.client import APIClient
```
Complete the authentication process using the **'set\_credentials'** method with your parameters.
```python
# API client
client = APIClient()
# Set your domain
client.set_domain("")
# Set your credentials
client.set_credentials(
access_key="",
secret_key="",
account_id=""
)
```
After this step, you can use the other methods as you wish without having to authorize each service in the SDK over and over again.
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
The Node.js SDK must be installed first:
```bash
npm install perculus-sdk
```
The SDK should be imported into the appropriate code block after ensuring that the SDK is installed:
```javascript
import APIClient from "perculus-sdk"
```
Complete the authentication process using the **'setCredentials'** method with your parameters.
```javascript
// API client
const client = new APIClient()
// Set your domain
client.setDomain("")
// Set your credentials
client.setCredentials(
access_key="",
secret_key="",
account_id=""
)
```
After this step, you can use the other methods as you wish without having to authorize each service in the SDK over and over again.
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
{% hint style="danger" %}
**The ACCESS\_TOKEN will be required for all future services. Therefore, remember to keep your ACCESS\_TOKEN in a safe place.**
{% endhint %}
# User Management
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
# Creating Users
This step shows how to create Groups users via GroupsAPI
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
Below is a list of available parameters when creating a user.
{% hint style="warning" %}
For an account, `email` and `username` of a user should be **unique** across **its users**.
{% endhint %}
**Example payload:**
{% tabs %}
{% tab title="CURL" %}
{% endtab %}
{% tab title="Python" %}
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
...
# Create user
user = client.users.create_user({
"name": "",
"surname": "",
"username": "",
"email": "",
"role": ""
})
print(user)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```javascript
import APIClient from "perculus-sdk"
// API client
const client = new APIClient()
...
// Create user
const user = client.users.createUser({
name: "",
surname: "",
username: "",
email: "",
role: ""
})
console.log(user)
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
**Example response:**
```json
{
"user_id": "",
"name": "john",
"surname": "Doe",
"username": "johndoe",
"email": "john@doe.com",
"role": "u",
"mobile": "",
"login_allowed": true,
"status": 1,
"lang": "tr-TR",
"timezone": null,
"expires_at": null,
"creation_date": "2024-08-01T00:45:03.8888474+00:00",
"updating_date": null
}
```
{% hint style="danger" %}
You must securely store the **USER\_ID** data in the data received in response to perform update/delete/assign operations on the user.
{% endhint %}
# Updating Users
This step shows how to update Groups users.
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
Below is a list of available parameters for updating users:
{% hint style="info" %}
If a parameter is not sent or if its null, it won't be applied. So if you only want to update the field email for a user, you don't have to send other parameters.
A request like so would achieve that:
```bash
curl --location --request PUT 'https:///xapi/user/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
"role": "a"
}'
```
{% endhint %}
**Example payload:**
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request PUT 'https:///xapi/user/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
"name": "John1",
"surname": "Doe1",
"username": "johndoe1",
"email": "john@doe.com1"
}'
```
{% endtab %}
{% tab title="Python" %}
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
...
# Update user
user = client.users.update_user("",{
"name": "john1",
"surname": "Doe1",
"username": "johndoe1",
"email": "john@doe.com1"
})
print(user)
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```javascript
import APIClient from "perculus-sdk"
// API client
const client = new APIClient()
...
// Update user
const user = client.users.updateUser("", {
name: "",
surname: "",
username: "",
email: "",
role: ""
})
console.log(user)
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
**Example response:**
```json
{
"user_id": "",
"name": "john1",
"surname": "Doe1",
"username": "johndoe1",
"email": "john@doe.com1",
"role": "u",
"mobile": "",
"login_allowed": true,
"status": 1,
"lang": "tr-TR",
"timezone": null,
"expires_at": null,
"creation_date": "2024-08-01T00:45:03.8888474+00:00",
"updating_date": null
}
```
# Removing Users
This step shows how to remove users from your Groups platform.
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
Below is an example of the delete operation with the \ parameter for a user:
{% tabs %}
{% tab title="CURL" %}
```bash
curl --location --request DELETE 'https:///xapi/user/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data ''
```
{% endtab %}
{% tab title="Python" %}
```python
from perculus_sdk.client import APIClient
# API client
client = APIClient()
...
# Delete User
client.users.delete_by_user_id("")
```
{% endtab %}
{% tab title="C#" %}
```
// ASAP :)
```
{% endtab %}
{% tab title="NodeJS" %}
```javascript
import APIClient from "perculus-sdk"
// API client
const client = new APIClient()
...
// Create user
client.users.deleteUser("")
```
{% endtab %}
{% tab title="Go" %}
```
// ASAP :)
```
{% endtab %}
{% endtabs %}
# Filtering Users
This step shows how to filter users
{% hint style="danger" %}
**Important Note!**\
\
Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward.\
\
Link to V2 API documentation:
{% endhint %}
Available parameters:
