{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6b1dc850-1bbf-4861-b734-97220951b9b7","name":"Simbase API v1 Reference","description":"# 🎉 Simbase API v2 is now available! 🎉\n\nThe new iteration of the Simbase Public API is now available to everyone!\n\nDocumentation is now held at the [<b>Simbase Developer Portal (developer.simbase.com)</b>](https://developer.simbase.com).\n\n---\n\nIf you are new to Simbase APIs, please skip this API version as it won't be accessible with API Keys created on your account.\n\nIf you are currently using API v1, we highly recommend you check out API v2 and its new enhancements, including:\n\n- Scoped API Keys to enhance the security of your resources\n    \n- Consistent and robust endpoints with standardized data structures, formats and types\n    \n- Brand new features!\n    \n\n> ❗ HEADS UP ❗  \nNewly created API keys will **NOT** work with API v1. Your current API keys will continue to work indefinitely and Simbase API v1 will stick around for the foreseeable future. \n  \n\nThis is to ensure that the authorization scopes you select at creation will be enforced, something that this API version does not support.  \nIf you are still using Simbase API v1, can not migrate to Simbase API v2 and need new API Keys to be authorized on Simbase API v1, let us know at [<b>support@simbase.com</b>](https://mailto:support@simbase.com)\n\n---\n\n## Simbase API v1 Reference\n\n###### The Simbase API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). It helps you manage and deploy cellular IoT devices around the world at scale. We use predictable and clear resource-oriented URLs that utilize built-in HTTP features like authentication, verbs and error codes. Copy and paste examples and use any HTTP client in any language to make requests, or import this collection directly into [Postman](https://www.getpostman.com/).\n\n**To get started and see the results, make sure to** [<b>get a Simbase SIM</b>](https://store.simbase.com/) **and** [<b>sign-up</b>](https://dashboard.simbase.com/auth/signup) **or** [<b>login</b>](https://dashboard.simbase.com/auth/signin) **to our** [<b>dashboard</b>](https://dashboard.simbase.com/)**.**\n\n## About the Simbase API\n\nSimbase continuously adds more APIs and features. If you have questions or have any requests for future APIs, [submit a support request](https://www.simbase.com/support-request) or create a feature request at [https://feedback.simbase.com](https://feedback.simbase.com).\n\nAll customers can use the API free of charge. Please be aware that some API calls trigger events, like sending an SMS, that bear costs. The SMS message is billed according to the rate plan assigned to your SIM card.\n\n---\n\n# Authentication\n\nTo make a successful API call, you need your account's API key. You can obtain and reset your API key in the [Simbase dashboard](https://dashboard.simbase.com). Log in and go to 'API Key' under 'Settings'. API keys are only visible for Admin users.\n\nTo make a successful API call put the header below in every API call:\n\n```\n{\"x-api-key\":\"{{Your API Key}}\" }\n\n ```\n\n---\n\n# Rate limits\n\nPlease limit your request to a maximum of 10 calls/second and 5000 calls/day. Should you require more calls, [submit a support request](https://www.simbase.com/support-request)\n\n---\n\n# Global Variables\n\n#### device_name \\[STRING\\]\n\nThe device_name is a custom identifier you can assign to a SIM card. The value will also appear in the [dashboard](https://dashboard.simbase.com).\n\n#### iccid (SIM Barcode) \\[string\\]\n\nTo address an individual SIM card in your account, the API requires an [iccid](https://en.wikipedia.org/wiki/SIM_card#ICCID) to identify the subscription. The iccid is the barcode printed on the SIM card. You can get an overview of the iccid's in the [dashboard](https://dashboard.simbase.com) of your account, or call the 'sims' API.\n\n#### plan_id \\[STRING\\]\n\nThe plan_id is the identifier of the rate plan that is assigned to this SIM card. A rate plan is a commercial plan or bundle, that defines how usage of a SIM card is billed.\n\n#### sim_state \\[STRING\\]\n\nThere are 4 SIM states that you can assign to your SIM card. The different SIM states have implications on service- and billing states.\n\n| SIM State | Service | Billable | Remark |\n| --- | --- | --- | --- |\n| enabled | All services are allowed | Yes |  |\n| disabled | All services are blocked | No |  |\n| Blocked - enabled | All services are blocked | No | A top-up is required to start using the card again. |\n| Blocked - disabled | All services are blocked | No | A top-up is required to start using the card again. |\n\n#### usage_data \\[INTEGER\\]\n\nThe aggregated data usage of a SIM in bytes for the current calendar month. Please note that 1MB = 1024kb = 1048576 bytes.\n\n#### sms_sent \\[INTEGER\\]\n\nThe number of SMS messages sent by this SIM card during this calendar month.\n\n#### sms_received \\[INTEGER\\]\n\nThe number of SMS messages received by this SIM card during this calendar month.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"20506410","team":3336541,"collectionId":"6b1dc850-1bbf-4861-b734-97220951b9b7","publishedId":"UVz1Psex","public":true,"publicUrl":"https://docs.simbase.com","privateUrl":"https://go.postman.co/documentation/20506410-6b1dc850-1bbf-4861-b734-97220951b9b7","customColor":{"top-bar":"FFFFFF","right-sidebar":"123466","highlight":"FF5745"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-04-13T14:10:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/958b92eb741c8430b27e91a71b3321e501684fc882b5e8e9d3123c7d2b02e768","favicon":"https://res.cloudinary.com/postman/image/upload/v1649858803/team/aat1vxaqvufp9erhvc9t.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.simbase.com/view/metadata/UVz1Psex"}