netgsm/m2m

Netgsm

Maintainers

Details

github.com/netgsm/m2m

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:package

v1.0.1 2023-03-15 05:32 UTC

This package is auto-updated.

Last update: 2024-05-15 11:23:38 UTC


README

M2M API servisleri ile kullanabileceğiniz özellikler:

  • Aboneliğiniz ve ona bağlı hesaplara ait hat lisesi bilgisi (IMEI, IMSI, MSISDN) sorgulanabilir.

  • Hattınıza ait son kullanım miktarı ve son aktif olduğu tarih bilgisi alınabilir.

  • Hattınıza bağlı tarih bazlı data kullanım miktarı sorgulabilir.

  • Imei değişiklik geçmişi sorgulanabilir.

    M2M API servisleri içerisinde yer alan kavramlar

    Kavram Anlamı
    IMEI Uluslararası Mobil Cihaz Kodu. Her bir GSM telefon cihazına üretim aşamasında IMEI numarası yüklenmektedir. IMEI numarası her bir cihazın kimlik numarası olup tek ve benzersizdir ve 15 haneden oluşur.
    IMSI Uluslararası Mobil Abone Kimliği (IMSI) – Bu numara, SIM kartın çalıştığı şebeke olan bireysel operatör şebekesini tanımlar. şebeke sağlayıcısı ile SIM kartın iletişim kurabilmesini sağlar.
    ICCID ICCID (Entegre Devre Kartı Tanımlayıcısı) - Bir SIM kart, benzersiz seri numarasını (ICCID) içerir. ICCID'ler SIM kartlarda saklanır ve ayrıca bir kişiselleştirme işlemi sırasında SIM kart üzerinde basılır. ICCID, ITU-T tavsiyesi E.118 tarafından Birincil Hesap Numarası olarak tanımlanır.
    MSISDN GSM veya UMTS mobil şebekelerinde abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel bir numaradır.

İçindekiler

İletişim & Destek

Netgsm API Servisi ile alakalı tüm sorularınızı ve önerilerinizi teknikdestek@netgsm.com.tr adresine iletebilirsiniz.

Supported

Supported Laravel Versions

Laravel 6.x, Laravel 7.x, Laravel 8.x, Laravel 9.x, Laravel 10.x,

Supported Lumen Versions

Lumen 6.x, Lumen 7.x, Lumen 8.x, Lumen 9.x,

Supported Symfony Versions

Symfony 4.x, Symfony 5.x, Symfony 6.x

Supported Php Versions

PHP 7.2.5 ve üzeri

Kurulum

composer require netgsm/m2m

Doküman

API Servisi için hazırlanmış kapsamlı dokümana ve farklı yazılım dillerinde örnek amaçlı hazırlanmış örnek kodlamalara https://www.netgsm.com.tr/m2mapi/#m2m-api adresinden ulaşabilirsiniz.

GELİŞTİRİCİ HESABI

Netgsm hizmetlerini yazılımlarına entegre eden geliştiricileri Netgsm Geliştirici Hesabı ile geliştirici ekosistemine dahil ediyoruz, https://www.netgsm.com.tr/gelistiriciler/ adresinden bir geliştirici hesabı oluşturabilirsiniz.

Sistemde aktivasyonunuz onaylandıktan sonra, portal üzerinden https://www.netgsm.com.tr Geliştirici sekmesinden uygulamalarınızı kaydedebilirsiniz.

Geliştirici hesabınıza eklediğiniz Uygulanmanızın onaylandıktan sonra Netgsm Entegrasyon Listesinde yayınlanır ve göndereceğiniz SMS methoduna göre bize appkey parametresinde uygulama kodunuzu iletebilirsiniz.

Geliştirici hesabı ile;

  • Uygulamalarınıza ya da senaryonuza en uygun hizmeti size sunmak
  • Uygulamanız özelinde taleplerin, geliştirmelerin alınması için teknik ekip ile görüşmelerinizin yapılabilir olması
  • Geliştirme ve güncellemelerden anlık haberdar olmanız sağlanır.

APPKEY

Entegrasyonlarınızın yayınlanması ve gönderimlerinizde appkey parametresi göndermeniz;

  • Arızalarda doğrudan irtibata geçilmesi
  • Yazılım kaynaklı problem tespit edildiğinde tarafınıza bilgi verilmesi
  • Gönderim istatistik ve raporlarınız açısından kolaylık sağlar.

YETKİLENDİRME

  • M2M API servisi ile işlem yapabilmek için erişim anahtarı almanızı sağlar.
  • API servisi ile yapacağınız diğer işlemler için bu yetkilendirmeye ihtiyaç duyulmaktadır.
  • Servisten alınan yanıt JSON türündedir.
Tanımlar
Değişken Anlamı
username Hizmet aldığınız abone numarası. (Zorunlu parametre)
password Kullanıcı şifresi. (Zorunlu parametre)
appkey Geliştirici hesabınızdan yayınlanan uygulamanıza ait id bilgisi. (Zorunlu parametre.)
Örnek
      use Netgsm\M2m\m2m;
      $islem=new m2m;
      $data=array(
            'username'=>'510xxxxxxx',
            'password' => 'xxxxxx',
            'appKey' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

      );
      $sonuc=$islem->yetkilendirme($data);
      dd($sonuc);
      die;

Başarılı Sorgulama


Array
(
    [token] => 'token'
    [exp] => 1681455059
)

Başarısız Sorgulama

Array
(
    [message] => An error occurred in the login service
)

HAT LİSTESİ

Yetkilendirdiğiniz aboneliğinize bağlı hat listesine ve detaylarına (imei,iccid vs.) ulaşabilirsiniz.

Tanımlar

Değişken Anlamı
Authorization:Bearer Yetkilendirme isteği sonucunda alınan token değeri (Zorunlu parametre)
Örnek
      use Netgsm\M2m\m2m;
      $islem=new m2m;
      $token='token degeri';
      $sonuc=$islem->hatlistesi($token);
      dd($sonuc);
      die;

Başarılı Sorgulama

Array
(
    [data] => stdClass Object
        (
            [company] => NETGSM İLETİŞİM VE BİLGİ TEKNOLOJİLERİ A.Ş
            [main_account] => Array
                (
                    [0] => stdClass Object
                        (
                            [imei] => 
                            [iccid] => xx
                            [msisdn] => xx
                            [imsi] => xx
                        )

                )

            [sub_accounts] => Array
                (
                    [0] => stdClass Object
                        (
                            [imei] => 
                            [iccid] => xx
                            [msisdn] => xx
                            [imsi] => xx
                            [account_type] => Credit and Management Sharing
                        )

                    [1] => stdClass Object
                        (
                            [imei] => 
                            [iccid] => xx
                            [msisdn] => xx
                            [imsi] => xx
                            [account_type] => Credit and Management Sharing
                        )


                    

                )

        )

)

Başarısız Sorgulama

Array
(
    [status] => 0
    [reply] => Expired!
)

Servisten Dönen Yanıt

Parametre Anlamı
company Telefon numarasının kayıtlı olduğu kurum adı
imei Yetkilendirdiğiniz telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
iccid Telefon numarası ile eşleştirilmiş simkart seri numarası.
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
account_type Hesap türü.
imsi Bu numara SIM kartın çalıştığı şebeke olan bireysel operatör şebekesini tanımlar. şebeke sağlayıcısı ile SIM kartın iletişim kurabilmesini sağlar.

Hata Durumları

HTTP status Parametre Hata mesajı
301 Moved Permanently message Couldn't find any record(s)
400 Bad Request status reply 0 Expired!

HAT DETAYI

Tanımlar

Değişken Anlamı
Authorization:Bearer Yetkilendirme isteği sonucunda alınan token değeri (Zorunlu parametre)
imei Yetkilendirdiğiniz telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
iccid Telefon numarası ile eşleştirilmiş simkart seri numarası.
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
Örnek
      use Netgsm\M2m\m2m;
      $islem=new m2m;
        $data=array(
              'tokendegeri'=>xx',
              'imei' => 'xx',
              'iccid' => 'xx',
              'msisdn'=>'xx'
  
        );
        $sonuc=$islem->hatdetay($data);
        dd($sonuc);
        die;

Başarılı Sorgulama

Array
(
    [data] => stdClass Object
        (
            [company] => NETGSM İLETİŞİM VE BİLGİ TEKNOLOJİLERİ A.Ş
            [line_information] => stdClass Object
                (
                    [aggreement_date] => 17.06.2022 09:23
                    [account_type] => Credit and Management Sharing
                    [imei] => xx
                    [iccid] => xx
                    [msisdn] => xx
                    [imsi] => xx
                )

            [usage_information] => stdClass Object
                (
                    [used_kbytes] => xx
                    [last_update] => 15.03.2023 10:38
                )

            [commitment_detail] => Array
                (
                    [0] => stdClass Object
                        (
                            [service_title] => M2M Data
                            [tariff_title] => 250 MB M2M Data
                            [end_date] => 17.06.2023 00:00
                        )

                )

        )

)


Başarısız Sorgulama

Array
(
    [status] => 0
    [reply] => Expired!
)

Servisten Dönen Yanıt

Parametre Anlamı
company Telefon numarasının kayıtlı olduğu kurum adı.
aggreement_date Sözleşme tarihi.
account_type Hesap türü.
imei Telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
iccid Telefon numarası ile eşleştirilmiş sim kart seri numarası.
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
imsi Bu numara SIM kartın çalıştığı şebeke olan bireysel operatör şebekesini tanımlar. şebeke sağlayıcısı ile SIM kartın iletişim kurabilmesini sağlar.
used_kbytes Data kullanım miktarı
last_update Son güncel olma tarihi
service_title Servis adı.
tariff_title Tarife adı.
end_date Tarife bitiş tarihi.

Hata Durumları

HTTP status Parametre Hata mesajı
400 Bad Request status reply 0 Expired!
404 Not Found message Couldn't find any record(s)!
422 Unprocessable Entity message imei iccidphone_number The given data was invalid.The imei field is required when none of iccid / phone number are present.
The iccid field is required when none of imei / phone number are present.The phone number field is required when none of imei / iccid are present.

TARİH BAZLI DATA KULLANIMI

Tanımlar

Değişken Anlamı
Authorization:Bearer Yetkilendirme isteği sonucunda alınan token değeri (Zorunlu parametre)
imei Yetkilendirdiğiniz telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
iccid Telefon numarası ile eşleştirilmiş simkart seri numarası.
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
startDate Sorgulanacak data kullanımının başlangıç tarihi. DD.MM.YYY formatında olmalıdır. (Zorunlu parametre)
endDate Sorgulanacak data kullanımının bitiş tarihi. DD.MM.YYY formatında olmalıdır. (Zorunlu parametre)
page Sayfa numarası.
Örnek
        use Netgsm\M2m\m2m;
        $islem=new m2m;
        $data=array(
              'tokendegeri'=>'XX',
              'imei' => 'XX',
              'iccid' => 'XX',
              'msisdn'=>'XX',
              'startDate'=>'01.01.2022',
              'endDate'=>'30.12.2022',
              'page'=>1
        );
        $sonuc=$islem->tarihbazlidata($data);
        dd($sonuc);
        die;

Başarılı Sorgulama

Array
(
    [data] => stdClass Object
        (
            [company] => NETGSM İLETİŞİM VE BİLGİ TEKNOLOJİLERİ A.Ş
            [line_information] => stdClass Object
                (
                    [aggreement_date] => 17.06.2022 09:23
                    [account_type] => Credit and Management Sharing
                    [imei] => xx
                    [iccid] => xx
                    [msisdn] => xx
                    [imsi] => xx
                )

            [total_data_usage] => 53
            [current_page] => 1
            [total_pages] => 1
            [total_records] => 1
            [results] => stdClass Object
                (
                    [2022-06-17] => stdClass Object
                        (
                            [used_kbytes] => 53
                            [last_update] => 2022-09-01 09:10:06.400
                        )

                )

        )

)


Başarısız Sorgulama

Array
(
    [status] => 0
    [reply] => Expired!
)

Servisten Dönen Yanıt

Parametre Anlamı
company Telefon numarasının kayıtlı olduğu kurum adı
aggreement_date Sözleşme tarihi.
account_type Hesap türü.
imei Yetkilendirdiğiniz telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
iccid Telefon numarası ile eşleştirilmiş simkart seri numarası.
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
imsi Bu numara SIM kartın çalıştığı şebeke olan bireysel operatör şebekesini tanımlar. şebeke sağlayıcısı ile SIM kartın iletişim kurabilmesini sağlar.
total_data_usage Toplam data kullanım miktarı
current_page Güncel sayfa
total_pages Toplam sayfa sayısı
total_records Toplam kayıt sayısı
used_kbytes Data kullanım miktarı
last_update Son güncel olma tarihi

Hata Durumları

HTTP status Parametre Hata mesajı
301 Moved Permanently message Couldn't find any record(s)
400 Bad Request message status reply
401 Unauthorized message Unauthorized.
422 Unprocessable Entity message
imei
phone_number
The given data was invalid.
The phone number field is required.
The phone number field is required.

IMEI DEĞİŞİM GEÇMİŞİ

Tanımlar

Değişken Anlamı
Authorization:Bearer Yetkilendirme isteği sonucunda alınan token değeri (Zorunlu parametre)
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
Örnek
        use Netgsm\M2m\m2m;
        $islem=new m2m;
        $data=array(
              'tokendegeri'=>'XXX',
              'msisdn'=>'XX',          
        );
        $sonuc=$islem->imeigecmis($data);
        dd($sonuc);
        die;

Başarılı Sorgulama

Array
(
    [data] => stdClass Object
        (
            [results] => Array
                (
                    [0] => stdClass Object
                        (
                            [imei] => XX
                            [date] => 26.07.2022 14:33
                            [msisdn] => XX
                            [iccid] => XX
                            [imsi] => XX
                        )

                    [1] => stdClass Object
                        (
                            [imei] => XX
                            [date] => 17.06.2022 07:01
                            [msisdn] => XX
                            [iccid] => XX
                            [imsi] => XX
                        )

                )

        )

)


Başarısız Sorgulama

Array
(
    [status] => 0
    [reply] => Expired!
)

Servisten Dönen Yanıt

Parametre Anlamı
imei Telefon numarası ile eşleşen Uluslararası Mobil Cihaz Kodu.
date Imei değişim tarihi
msisdn Abonenin tanımlanması ve doğrulanması için operatör tarafından aboneye atanan özel numara.
iccid Telefon numarası ile eşleştirilmiş simkart seri numarası.
imsi Bu numara SIM kartın çalıştığı şebeke olan bireysel operatör şebekesini tanımlar. şebeke sağlayıcısı ile SIM kartın iletişim kurabilmesini sağlar.

Hata Durumları

HTTP status Parametre Hata mesajı
301 Moved Permanentlyt message Couldn't find any record(s)
400 Bad Request status
reply
0
Expired!