RemotePC Enterprise API istekleri kabul eder ve yanıtları 'JSON' biçiminde döndürür. API Anahtar Kimlik Doğrulama mekanizması, API'lerin kimliğini doğrulamak için IP beyaz listesiyle birlikte kullanılır. Tüm API'ler için yetkilendirme başlığına API Anahtarı eklenmelidir.
API isteklerini web konsolunda hesabınız için oluşturulan API Anahtarını kullanarak gönderebilirsiniz.
API anahtarını almak için,
- RemotePC Enterprise hesabınıza giriş yapın.
- Hesabım sekmesine gidin ve API Anahtarları'na tıklayın.
- Görüntüle'ye tıklayın, hesap parolasını girin ve Görüntüle'ye tıklayın.
- API Anahtarı görüntülenecektir. Panoya kopyalamak için Anahtarı Kopyala 'ya tıklayın.
API Anahtarını değiştirmek için Değiştir'e tıklayın. Hesap parolasını girin ve yeni API anahtarını görüntülemek için Görüntüle 'ye tıklayın.
Not: API Anahtarını yalnızca Yönetici (hesap sahibi) oluşturabilir.
1. Kullanıcı davet et
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string[]: e-posta - Zorunlu
int: status_2FA - İsteğe bağlı (izin verilen değerler 0 ve 1'dir; 1 - Durum AÇIK & 0 - Durum KAPALI)
Http yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
Örnek 1 talep edin
{
"email": [
"shane@myworld"
]
}
Örnek 2 talep edin
{
"email": [
"shane@myworld"
],
"status_2FA":1
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Yanıt hatası örneği
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Açıklama şunları içerebilir
BAŞARISIZ
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı
Geçersiz kullanıcı izni
Geçersiz kullanıcı planı
Geçersiz iki faktör durumu
2. Kullanıcı oluştur
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string: firstname - Zorunlu
string: lastname - Zorunlu
string: kullanıcı adı - Zorunlu
string: password - Zorunlu
int: status_2FA - İsteğe bağlı (izin verilen değerler 0 ve 1'dir; 1 - Durum AÇIK & 0 - Durum KAPALI)
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
Örnek 1 talep edin
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Örnek 2 talep edin
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
Açıklama şunları içerebilir
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
First name cannot be blank
First name can contain a-z, A-Z and space
Last name cannot be blank
Last name can contain a-z, A-Z and space
Username/Email cannot be blank
Enter a valid Username/Email
Password cannot be blank
Password can contain A-Z, a-z, 0-9 and ~`!@#$%^&*()-_+={}|[];\'\"<>,.?/
Password should be between 6 - 20 characters
Email is already in use or already invited.
Email in use with other Admin
Invalid two factor status
3. Kullanıcı silme
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string[]: sub_ids - Zorunlu
string[]: invited_ids - Zorunlu
sub_ids: Aktif Kullanıcı E-posta Kimlikleri,
invited_ids: Davet Edilen Kullanıcı E-posta Kimlikleri
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
Örnek talep edin
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Yanıt hatası örneği
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Açıklama şunları içerebilir
BAŞARISIZ
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı
Geçersiz kullanıcı izni
Geçersiz kullanıcı planı
4. Kullanıcıları alın
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Yöntem-Türü: GET
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
Int pageIndex - İsteğe bağlı
Int recordPerPage - İsteğe bağlı, Varsayılan değer 500
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"pageIndex": 1,
"recordPerPage": 30
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"pagination": {
"records_per_page": 30,
"total_records": 1,
"total_page_count": 1,
"current_page_index": 1
}
"users": [
{
"firstname": "firstname",
"username": "shane@mymail",
"lastname": "lastname"
]
}
}
}
Beklenen hata örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Açıklama şunları içerebilir
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
Geçersiz sayfa dizini
Not: Tek seferde talep edilebilecek maksimum kullanıcı listesi sayısı 500'dür.
5. Kullanıcıya bilgisayar atayın
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string: kullanıcı adı - Zorunlu
string[]: computer_names - Zorunlu
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Açıklama şunları içerebilir
Kullanıcı adı gereklidir
Bilgisayar adları istekte bulunamadı
Kullanıcı bulunamadı
Bilgisayar(lar) bulunamadı
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
6. Kullanıcıya bilgisayar atamasını kaldırın
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string: kullanıcı adı - Zorunlu
string[]: computer_names - Zorunlu
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Açıklama şunları içerebilir
Kullanıcı adı gereklidir
Bilgisayar adları istekte bulunamadı
Kullanıcı bulunamadı
Bilgisayar(lar) bulunamadı
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
7. Grup oluşturma ve bilgisayarları taşıma
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string: group_name - Zorunlu
string[]: computer_names - İsteğe bağlı
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Açıklama şunları içerebilir
Kullanıcı adı gereklidir
Bilgisayar adları istekte bulunamadı
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
Grup adı boş bırakılamaz
Grup adı zaten mevcut
Geçersiz grup adı
8. Bilgisayar(lar)ı çıkarın
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek
string[]: computer_names - Zorunlu
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Açıklama şunları içerebilir:
Geçersiz kullanıcı
Bilgisayar adları istekte bulunamadı
Bilgisayar sınırı aşıldı
Bilgisayar(lar) bulunamadı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
Not: Yalnızca çevrimdışı bilgisayarlar kaldırılabilir. Bir seferde en fazla 50 bilgisayar kaldırılabilir.
9. Bilgisayar için yorum ekle
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek:
string: computer_name - Zorunlu
string: comment_desc - Zorunlu
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Açıklama şunları içerebilir
Kullanıcı adı gereklidir
Bilgisayar adı boş olamaz
Yorumlar boş bırakılamaz
Yorum uzunluğu 6 ila 250 arasında olmalıdır
Bilgisayar bulunamadı
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
10. Cihazları alın
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Yöntem-Türü: GET
İstek başlıkları:
- Authorization: Bearer <api key>
- İçerik türü: application/json
İstek:
Int pageIndex - İsteğe bağlı
Int recordPerPage - İsteğe bağlı, Varsayılan değer 500
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"pageIndex": 1,
"recordPerPage": 30
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": {
"devices": [
{
"machine_id": "###################",
"host_name": "Computer A",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 11:07:11",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
{
"machine_id": "###################",
"host_name": "Computer B",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 10:56:01",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
]
"pagination": {
"records_per_page": 30,
"total_records": 2,
"total_page_count": 1,
"current_page_index": 1
}
}
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Açıklama şunları içerebilir
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
Geçersiz sayfa dizini
Not: Tek seferde talep edilebilecek maksimum cihaz listesi sayısı 500'dür.
11. Bilgisayarları bir gruba taşıma
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Yöntem-Türü: POSTA
İstek başlıkları:
- Authorization header: Bearer <api key>
- İçerik türü: application/json
İstek:
string: group_name- Zorunlu
string[]: computer_names- Zorunlu
HTTP yanıtı
200 (Başarılı)
500 (Sunucu Hatası)
400 (Geçersiz Parametreler)
401 (Yetkisiz)
403 (Geçersiz istek)
404 (Bulunamadı)
Örnek talep edin
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Yanıt örneği
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Yanıt hatası örneği
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Beklenen hata yanıtı
Bilgisayar adları istekte bulunamadı
Geçersiz kullanıcı
Geçersiz kullanıcı izni
INTERNAL_SERVER_ERROR
Geçersiz kullanıcı planı
Grup adı boş bırakılamaz
Grup adı mevcut değil
Geçersiz grup adı