| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:sim_cards [2017/02/20 11:59] – michal | api:sim_cards [2018/12/10 13:20] – michal |
|---|
| |
| ===== Stav SIM karty a přepínání parametrů ===== | ===== Stav SIM karty a přepínání parametrů ===== |
| | |
| | === GET /sim_cards.json === |
| | * výpis nastavení parametrů všech SIM karet daného uživatelského účtu (nebo pouze linky v případě autentizace přes linku) |
| | * vyžaduje [[:api#autentizace|autentizaci]] |
| | * parametry a výstup jsou totožné jako v případě GET /sim_cards/<mobilni_cislo>.json, pouze je vráceno více SIM v poli |
| |
| === GET /sim_cards/<mobilni_cislo>.json === | === GET /sim_cards/<mobilni_cislo>.json === |
| * **include_available_roaming_settings** | * **include_available_roaming_settings** |
| * příklad odpovědi na požadavek společně s include_available_data_packages: | * příklad odpovědi na požadavek společně s include_available_data_packages: |
| | <code> |
| | curl -X GET https://www.odorik.cz/api/v1/sim_cards/00420799799081.json -d user=6096177 -d password=xxxxxx -d include_available_data_packages=true |
| | </code> |
| <code javascript> | <code javascript> |
| { "id": 5, | { "id": 1013, |
| "sim_number": "2145F7Q", | "sim_number": "8942001100038961787F", |
| "state": "active", | "state": "active", |
| "changes_in_progress": [], | "changes_in_progress": [], |
| "data_package": "150MB", | "data_package": "perKB_50MB", |
| "data_package_for_next_month": "perKB", | "data_package_for_next_month": "perKB_100MB", |
| "data_bought_total": 157286400, | "data_bought_total": null, |
| "data_used": 0, | "data_used": null, |
| "voice_package": "none", | "voice_package": "none", |
| "voice_package_for_next_month": "none", | "voice_package_for_next_month": "none", |
| "package_delayed_billing": "none", | "package_delayed_billing": "none", |
| "package_delayed_billing_for_next_month": "none", | "package_delayed_billing_for_next_month": "none", |
| "missed_calls_register": false, | "missed_calls_register": true, |
| "mobile_data": false, | "mobile_data": true, |
| "lte": false, | "lte": true, |
| "lte_for_next_month": false, | "lte_for_next_month": true, |
| "roaming": "off", | "roaming": "eu_data_outgoing", |
| "premium_services": "off", | "premium_services": "off", |
| "available_data_packages": [ | "available_data_packages": [ |
| {"name": "perKB", "price": 0}, | {"name":"perKB_50MB","price":0}, |
| {"name": "25MB", "price": 20}, | {"name":"perKB_100MB","price":0}, |
| {"name": "100MB", "price": 50}, | {"name":"perKB_200MB","price":0}, |
| {"name": "150MB", "price": 69}, | {"name":"perKB_400MB","price":0}, |
| {"name": "300MB", "price": 128}, | {"name":"perKB_500MB","price":0}, |
| {"name": "500MB", "price": 190}, | {"name":"150MB","price":60}, |
| {"name": "1000MB", "price": 290}, | {"name":"300MB","price":95}, |
| {"name": "1500MB", "price": 390}, | {"name":"600MB","price":160}, |
| {"name": "2000MB", "price": 450}, | {"name":"1000MB","price":220}, |
| {"name": "3000MB", "price": 490}, | {"name":"1500MB","price":295}, |
| {"name": "10GB", "price": 690} ] | {"name":"2000MB","price":320}, |
| | {"name":"3000MB","price":440}, |
| | {"name":"10GB","price":690} ] |
| } | } |
| </code> | </code> |
| * **roaming**: viz zdroj dostupných nastavení roamingu | * **roaming**: viz zdroj dostupných nastavení roamingu |
| * **premium_services**: off/sms_payments_and_dms/all_other_than_sms_payments_and_dms/all | * **premium_services**: off/sms_payments_and_dms/all_other_than_sms_payments_and_dms/all |
| | * **add_credit**: dokup dat, viz seznam nabízených dokupů |
| | |
| | === POST /sim_cards/<mobilni_cislo>/data_restart === |
| | * provede změny vedoucí k odblokování FUP na SIM kartě v závislosti na aktuálním datovém balíčku: |
| | * v případě účtování po kB dojde k resetu FUP přepnutím na jiný typ datového tarifu a zase zpět |
| | * v případě datového balíčku dojde k přepnutí na účtování po kB |
| | * vyžaduje [[:api#autentizace|autentizaci]] |
| | * možné chybové stavy: |
| | * //change_in_progress// - na SIM probíhá nějaká jiná změna |
| | * //low_balance// - nedostatečný kredit, nutno nebýt v záporu |
| | * //mobile_data_disabled// - na SIM nejsou povolena mobilní data |
| | * příklad použití: |
| | <code> |
| | curl -X POST https://www.odorik.cz/api/v1/sim_cards/00420799799081/data_restart -d user=6096177 -d password=xxxxxxx |
| | </code> |
| | <code> |
| | ok |
| | </code> |
| |
| ===== Historie mobilních dat ===== | ===== Historie mobilních dat ===== |
| * **pin**: PIN1 SIM karty | * **pin**: PIN1 SIM karty |
| * nepovinné parametry: | * nepovinné parametry: |
| * **delayed_activation**: výchozí hodnota je false; v opačném případě je přiřazení jen předchystáno a je dokončeno až po potvrzení uvnitř uživatelského rozhraní | * **delayed_activation**: výchozí hodnota je false; v opačném případě je přiřazení jen předchystáno a je dokončeno až po potvrzení uvnitř uživatelského rozhraní, nebo přes api. Předchystanou sim lze pracovat i s API pomocí "Stav SIM karty a přepínání parametrů", je ve stavu //new//, aktivovat ji lze přes API změnou do stavu //active//. |
| * vyžaduje [[:api#autentizace|autentizaci]] | * vyžaduje [[:api#autentizace|autentizaci]] |
| * při úspešném provedení vrací prázdný objekt: <code>{}</code> | * při úspešném provedení vrací prázdný objekt: <code>{}</code> |