Grizzly CMS iş ortağı API belgeleri

Краткое описание работы протокола

Ortaklık protokolü, API aracılığıyla numaraları ve gelen SMS'leri doğrudan Grizzly SMS sunucusuna sağlamak için tasarlanmıştır.

Tüm isteklerde "KEY" parametresi kullanılmaktadır. Bu anahtar destek personeli tarafından verilir.

GET_SERVICES, GET_NUMBER ve FINISH_ACTIVATION istekleri doğrudan sunucumuzdan ortak sunucuya gönderilir.

URL formatı - https://GrizzlySMS, burada Grizzly SMS partner.ru:port/GrizzlySMS.php veya partner.ru/GrizzlySMS.php olabilir.

GET_SERVICES

GET_NUMBER

PUSH_SMS

FINISH_ACTIVATION

Grizzly SMS sunucusu, GET_SERVICES yöntemiyle her 10-20 saniyede bir numara miktarı talebi gönderir.

Eğer 0'dan daha büyük bir miktar veriyorsanız, GET_NUMBER numarası talebi alırsınız.

GET_NUMBER isteği sonrasında tüm kriterlere uygun bir telefon numarası vermelisiniz ve bize gelen tüm giriş SMS'lerini PUSH_SMS yöntemiyle iletmelisiniz. Bu, net ve tarafsız bir filtreleme yapabilmemiz ve müşteriye doğru hizmet için gerekli SMS'leri vermemiz için gereklidir.

Numara ile gerekli tüm çalışmaların sonunda, FİNİSH_ACTİVATİON yöntemine göre 3 statüsünü alacaksınız. Bu, numaranın başarıyla satın alındığı ve bunun için size bir ödül verildiği anlamına gelir.

Gereksinimler:

  • JSON istek/yanıt biçimi
  • UTF-8 kodlaması
  • Grizzly SMS sunucusuna yapılan isteklerde "user-agent header" kullandığınızdan emin olun

 

Alan Türleri:

  • int sayısı: -2.147.483.648 ile 2.147.483.647 arasında değişen bir tamsayı
  • uint sayısı: 0 ile 2,147,483,647 arasında işaretsiz bir tamsayı değeri
  • long sayısı: -9.223.372.036.854.775.808 ile 9.223.372.036.854.775.807 arasında değişen bir tamsayı
  • ulong sayısı: 0 ile 9 arasında değişen işaretsiz bir tamsayı değeri 223 372 036 854 775 807
  • cur sayısı: noktadan sonra en fazla 2 karakter içeren gerçek değer, örneğin 177.77
  • boolean: true veya false değerlerini alan değişmez değer
  • string: sınırsız uzunlukta dize değeri
  • array of string: dizi string
1. Метод запроса количества номеров GET_SERVICES

Bu talep bize satışa sunulan hizmetlerin sayısı hakkında bilgi aktarmaktadır.

POST isteği, Grizzly SMS sunucusundan iş ortağının sunucusuna yürütülür.

! Dikkat ediniz: Eğer GSM modeminiz aynı anda aktif modül sayısında sınırlı ise, aktif modül sayısına eşit miktarda vermelisiniz.

SORGU alanının bileşenleri.
Alan Tür Zorunlu Açıklama
action String
 
GET_SERVICES
key String
 
Protokol anahtarı
YANIT alanlarının bileşimi
Alan Tür Zorunlu Açıklama
status String
 
Yanıt durumu (bak Durum Tabloları)
countryList Array of CountryList
 
Ülkelerin listesi
 
CountryList
Alan Tür Zorunlu Açıklama
country String
 
Yanıt durumu (bak Durum Tabloları)
operatorMap* İlişkisel dizi
 
Anahtar operatörü (bak Durum Tabloları),
Değer, ilişkisel bir hizmet dizisidir**

* Operatormap'e boş veri dizileri göndermemelisiniz

** İlişkisel hizmetler dizisi: Anahtar — hizmetin kısa adı (bak Veri sayfası), değer - hizmet için oda sayısı (tür-int)

Örnek SORGU
{
  "action": "GET_SERVICES",
  "key": "qwerty123"
}
Örnek CEVAP
{
  "countryList":
    [
      {
        "country": "russia",
        "operatorMap":
          {
            "any":
              {
                "vk": 3,
                "ok": 10
              }
          }
      },
      {
        "country": "ukraine",
        "operatorMap":
          {
            "any":
              {
                "vk": 0,
                "wa": 32
              }
          }
      }
    ],
  "status": "SUCCESS"
}
2. Метод запроса номера GET_NUMBER

Bu talep, müşteriye ilettiğimiz telefon numarasını bize iletir.

POST isteği, Grizzly SMS sunucusundan iş ortağının sunucusuna yürütülür.

ExceptionPhoneSet dizisinde 44742 ve 44740 gibi bir önek listesi varsa, bu öneklerden biriyle başlayan bir numara vermemelisiniz. Basamak sayısı önek boyutuyla sınırlı değildir.

İSTEK alanlarının bileşimi
Alan Tür zorunlu Açıklama
action String
 
GET_NUMBER
key String
 
protokol anahtarı
country String
 
bak Veri sayfaları
service String
 
bak Veri sayfaları
operator String
 
protokol anahtarı
sum Cur
 
Başarıyla satılan hizmet için alacağınız miktar

exceptionPhoneSet

Array of String
 
Numara istendiğinde verilmesi yasak olan öneklerin listesi
YANIT alanlarının bileşimi
Alan Tür zorunlu Açıklama
status String
 
Yanıt durumu (bak Durum Tabloları)
number Ulong
 
Ülke kodu ile telefon numarası
activationId Ulong
 
İş ortağı sistemindeki aktivasyon kimliği
 
Örnek SORGU
{
  "action": "GET_NUMBER",
  "key": "qwerty123",
  "country": "russia",
  "operator": "any",
  "service": "tg",
  "sum": 20.00,
}
İstisna öneklerine sahip örnek sorgu
{
  "action": "GET_NUMBER",
  "key": "qwerty123",
  "country": "russia",
  "operator": "any",
  "service": "vk",
  "sum": 10,
  "exceptionPhoneSet": [
    "7918",
    "79281"
  ]
}
Örnek CEVAP
{
  "status": "SUCCESS",
  "number": 79157891133,
  "activationId": 571346
}
Numara olmaması durumunda cevap örneği
{
  "status": "NO_NUMBERS"
}
3. Метод доставки СМС на сервер Grizzly SMS PUSH_SMS

Bu POST isteği, iş ortağının sunucusundan Grizzly sunucusuna şu adrese iletilir: https://api.grizzlysms.com/agent/api/sms 

BAŞARI durumuyla bir yanıt alırsanız, veritabanınızda başarıyla teslim edilen SMS'i işaretleyin ve artık SMS göndermeyin. BAŞARI dışında bir durum döndürüldüyse, BAŞARI durumunu alana kadar isteği 10 saniye gecikmeyle tekrarlayın.

İSTEK alanlarının bileşimi
Alan Tür Zorunlu Açıklama
action String
 
PUSH_SMS
key String
 
Protokol anahtarı
smsId Ulong
 
Partner sistemindeki sms kimliği
phone Ulong
 
Sms'in geldiği telefon numarası (ülke kodu dahil)
phoneFrom String
 
SMS'i gönderen gönderenin adı (hem harf hem de sayısal ifade olabilir)
Text String
 
SMS metni
YANIT alanlarının bileşimi
Alan Tür Zorunlu Açıklama

status

String
 
Yanıt durumu (bak Durum Tabloları)
Örnek SORGU
{
  "action": "PUSH_SMS",
  "key": "qwerty123",
  "smsID": 1
  "phone": 447472190082
  "phoneFrom": "Microsoft",
  "text": "Microsoft access code: 5015"
}
Örnek CEVAP
{
  "status": "SUCCESS"
}
4. Метод запроса на завершение активации FINISH_ACTIVATION

Etkinleştirmeyi tamamlamak için bu isteği Grizzly CMS sunucusundan iş ortağının sunucusuna aktarıyoruz.

POST isteği, Grizzly SMS sunucusundan iş ortağının sunucusuna yürütülür.

Aktivasyonların yönetimi tamamen Grizzly CMS'DEN gerçekleşir. Kontrolümüz dışındaki nedenlerden dolayı, başarılı durum değişikliği hakkında sizden bir yanıt alamayabiliriz. Bu nedenle, Grizzly SMS aktivasyonun tamamlanmasını tekrar talep ederse, aktivasyonun varlığını kimliğinize göre kontrol etmeli ve aktivasyonunuz varsa BAŞARI durumunu göndermelisiniz.

İSTEK alanlarının bileşimi
Alan Tür Zorunlu Açıklama
action String
 
FINISH_ACTIVATION
key String
 
Protokol anahtarı
activationId Ulong
 
İkinci istekte alınan aktivasyon kimliği
status Ulong
 
Yanıt durumu (bak Durum Tabloları)
YANIT alanlarının bileşimi
Alan Tür Zorunlu Açıklama

status

String
 
Yanıt durumu (bak Durum Tabloları)
Örnek SORGU
{
  "action": "FINISH_ACTIVATION",
  "key": "qwerty123",
  "smsId": 100,
  "status": 3
}
Örnek CEVAP
{
  "status": "SUCCESS"
}
Тестирование протокола

AYNI ANDA NUMARA VERİLMESİ. Eşzamanlı istekleri düzgün bir şekilde ele almalı ve numaraları tekrar yayınlamamalısınız. Örneğin, Telegram İngiltere'ye 100 numara verirseniz, Grizzly CMS belirli bir ürün için aynı anda 1000 istek yaparsa, iş ortağının sunucusunun 100 benzersiz numara vermesi gerekir. Numara birkaç kez verilirse, test başarısız olur.

AKTİVASYONUN DOĞRU ŞEKİLDE TAMAMLANMASI. Aktivasyon durumundaki değişiklik tamamen Grizzly cms'nin tarafında gerçekleşir. Aktivasyonu kendiniz tamamlamamalısınız.

SMS VERİLMESİNİ KONTROL ETMEK. SMS'i aldıktan sonra, hemen Grizzly SMS sunucusuna yönlendirilmesi gerekir. Size BAŞARI durumu gönderildiyse, artık bu SMS'i göndermemelisiniz. Farklı bir durum alırsanız, isteği her 10-20 saniyede bir tekrarlamanız gerekir. BAŞARI durumunu aldıktan sonra SMS tekrar verilirse test yapılır. 

ALAN TÜRLERİNİ KONTROL EDİN. Bu belgelerde belirtilen alan türlerini dikkatlice kontrol edin. Bu durum ihlal edilmişse, test başarısız olur.

 

TELEFON NUMARASINDAKİ ÜLKE KODUNUN VARLIĞINI KONTROL ETMEK. Telefon numarasının verilmesi tamamen dijital biçimde ve ülke koduyla yapılmalıdır.

NUMARANIN VERİLDİĞİ ZAMANI KONTROL ETMEK. Numarayı 3 saniyeden az gecikmeyle vermelisiniz. 3 saniyeden fazla gecikme tespit edilirse test başarısız olur.

ODA SAYISINI KONTROL ETME. Numara sayısı isteğinde 1000 gösteriyorsanız ve aynı anda numara isteğinde yalnızca 100 veriyorsanız, test başarısız olur.

İSTİSNALARI KONTROL ETMEK. Bir numara vermek için istisnaları yanlış işliyorsanız, test başarısız olur.

Таблица статусов
İSTEK alanlarının bileşimi
Statü Şifre çözme
SUCCESS İstek başarıyla tamamlandı
ERROR Sorgu yürütülürken hata oluştu. HATA alanı bir açıklama ile doldurulmalıdır
NO_NUMBERS Numara yok. Yalnızca numara istendiğinde iade edilir
Aktivasyon durumu
Statü Şifre çözme

1

Hizmete konu numarasının verilmesi yasaktır
3 Aktivasyon başarıyla satıldı. Ödül aldınız
4 Aktivasyon iptal edildi*
5 Aktivasyon iade edildi. Aktivasyon için alıcıya para iade edildi. Belki bu numara daha önce kayıtlıydı ve numarada iki faktörlü kimlik doğrulama var

*İptal mekanizması ile çalışmanın açıklaması: Numara 5 kez iptal edilmişse, bu numarayı bize bir daha vermemelisiniz. Belki bu numara müşteriye uymadı veya bu hizmete zaten kayıtlıydı.

Talebe başarılı yanıt
{
  "status": "SUCCESS",
  //bilgi
}
Hata durumunda cevap
{
  "status": "ERROR",
 "error": "hatanın açıklaması"
}
Таблица данных
İSTEK alanlarının bileşimi
Liste Atıf
Ülkelerin listesi İsimleri ve kimlikleri olan ülkelerin tam listesi bağlantıdadır https://grizzlysms.com/api#countries
Operatörlerin listesi Şu anda, operatöre göre arıza geliştirme aşamasındadır, bu nedenle any değeri iletilmelidir. Bu işlevsellik uygulanır uygulanmaz, teknik destek sohbetinde sizi bilgilendireceğiz.
Hizmetlerin listesi Adları ve kimlikleri olan hizmetlerin tam listesi bağlantıdadır https://grizzlysms.com/api#services