🚀Hızlı Başlangıç

İlk isteğinizi atabilmek için aşağıdaki adımları takip etmeniz gerekmektedir:

• Hesap oluşturma

• API Kullanıcısı oluşturma

• Yetkilendirme

• İlk istek 🚀

Hesap Oluşturma

İlk olarak Perculus platformumuzdan bir hesap açmanız gerekmektedir. Hesabınız var ise bu adımı atlayabilirsiniz.

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.

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 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.

   

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.

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.

ACCOUNT_ID verisi için sistem yöneticiniz ile iletişime geçip hesabınıza ait olan "ACCOUNT_ID" verisine sahip olabilirsiniz

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

curl --location 'https://<DOMAIN>/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=<EMAIL>' \
--data-urlencode 'password=<PASSWORD>' \
--data-urlencode 'client_id=api' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'account_id=<ACCOUNT_ID>'

Parametrelerinizi doğru bir şekilde attığınızda aşağıdaki gibi bir response gelecektir.

{
    "access_token": "<ACCESS_TOKEN>",
    "expires_in": 36000,
    "token_type": "Bearer",
    "scope": "api"
}

ACCESS_TOKEN daha sonra kullanılacak tüm servislerde gerekecektir. Bu nedenle ACCESS_TOKEN'inizi güvenli bir yerde saklamayı unutmayın.

İlk İstek 🚀

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:

curl --location 'https://<DOMAIN>/xapi/session' \
--header 'Authorization: Bearer <ACCESS_TOKEN>'

Yukardaki örnek isteği attığınızda response olarak tüm oturumlarınızı listeleyebileceksiniz.

Bu sayede ilk isteğimizi atmayı başardık 🚀