{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f297adf9-1eb2-4c02-852b-b7d0ffec5ea0","name":"Yesim Partner API [core.yesim.biz]","description":"## **Introduction**\n\nWelcome to the Yesim Partner API documentation. This API is designed to facilitate integration and interaction with the core.yesim.biz platform, allowing partners to automate eSIM management processes. It is targeted towards developers and companies looking to incorporate Yesim’s functionalities into their own systems.\n\nThe Yesim Partner API provides a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) web services to integrate to your application with the core.yesim.biz platform.\n\n#### Base URL and API Version\n\n- **Base URL:** `https://partners-api.yesim.biz`\n    \n\nPlease ensure you use this base URL when constructing requests to the API.\n\n#### Getting Started\n\nTo begin using the Yesim Partner API, reach out to us at `b2b@yesim.app`, specifying your intention to utilize the core.yesim.biz platform. Our team will promptly contact you to assist with the onboarding process, ensuring you have everything needed to successfully integrate and start using the platform.\n\n#### Authentication\n\nUpon successful registration, each user is provided with a pre-configured account on the core.yesim.biz platform. The authentication token required to access the Yesim Partner API can be found within the user’s account on this platform.\n\n- The access token, obtained from core.yesim.biz platform, should be included in the request parameters\n    \n\n# Instruction\n\n### **Steps to Activate a Plan**\n\n1. Access the platform: [https://core.yesim.biz/](https://core.yesim.biz/)\n    \n2. Obtain an API token.\n    \n3. Select the desired plan.\n    \n4. Activate the plan.\n    \n5. Get eSim details.\n    \n\n_Optional:_\n\n- Create a user account\n    \n- Assign an eSIM to the user during eSIM creation.\n    \n- Verify the eSIM has been assigned, activated, and the plan is active.\n    \n- Confirm the purchase order has been generated.\n    \n\n### **Detailed Steps Explained:**\n\n#### **1.Platform Access**\n\nAccess to the platform is granted to partners by the Yesim team.\n\n#### **2\\. API Token Acquisition**\n\n_Via the platform_:\n\n1. Go to the API-token section at [https://core.yesim.biz/index.php?act=api_token](https://core.yesim.biz/index.php?act=api_token).\n    \n2. Copy the token and use it in all API requests.\n    \n\n#### **3\\. Retrieve Available Plans**\n\nSend a request to `/plans` to get the list of plans.\n\n**Example Request:**\n\n``` bash\ncurl --location 'https://partners-api.yesim.biz/plans?token=YOUR_API_TOKEN'\n\n ```\n\n**Response Example:**\n\n``` json\n[\n{\n\"id\": \"6314\",\n\"name\": \"Albania 0.49GB_20250318\",\n\"days\": \"1\",\n\"price\": \"0.55\",\n\"data\": \"0.49\",\n\"countries_included\": \"Albania\",\n\"countryIso2\": \"AL\",\n\"mcc\": \"276\",\n\"iso3\": \"ALB\",\n\"operators\": \"Vodafone Albania\",\n\"image\": \"https://cdn.yesim.app/flags/ALB.png\",\n\"apn\": \"plus\",\n\"plan_type\": \"country\"\n},\n///\n]\n\n ```\n\nSelect the plan `id` for activation.\n\n#### **4\\. Create eSIM**\n\nFor eSIM creation you have 2 options:\n\n1\\. You can create **a single eSIM**, using `/new_sim` request. `User id` parameter is optional. In case you need to assign user to the eSIM you can should use `/new_user` request first.\n\n2\\. You can use `/issue_esim` to order eSIMs **as a** **bulk**.\n\n#### 5\\. Plan Activation\n\nUse the ICCID and the selected plan ID in your request.\n\n**Example Request:**\n\n``` bash\ncurl --location --request POST 'https://partners-api.yesim.biz/add_plan_iccid?iccid=8937204017178107143&token=YOUR_API_TOKEN&plan_id=6314'\n\n ```\n\n**Response Example:**\n\n``` json\n{\n  \"status\":\"success\",\n  \"description\":\"OK\"\n}\n\n ```\n\nTo confirm activation, send a request to `/sim_info`.\n\n**Example Request:**\n\n``` bash\ncurl --location 'https://partners-api.yesim.biz/sim_info?token=YOUR_API_TOKEN&iccid=8937204017178107143'\n\n ```\n\n**Response Example:**\n\n``` json\n{\n\"id\": \"1825\",\n\"iccid\": \"8937204017178107143\",\n\"user_id\": \"352\",\n\"created_at\": \"2024-10-11 06:47:15\",\n\"active_plan_id\": \"6314\",\n\"plan_activated_at\": \"2025-03-28 10:41:41\",\n\"plan_expired_at\": \"2025-03-29 10:41:41\",\n\"qrcode\": \"LPA:1$smdp.io$K2-26L4KR-5PB4A8\",\n\"status_qr\": \"Released\",\n\"imsi\": \"260010199895794\",\n\"msisdn\": null,\n\"is_deleted\": \"0\",\n\"data_left_mb\": 501.76,\n\"data_package_mb\": 501.76,\n\"data_used_mb\": 0\n}\n\n ```\n\n#### 6\\. Get eSIM details\n\nThis endpoint is used to retrieve the details of a specific eSIM using the eSIM's ICCID. It provides comprehensive information associated with the given ICCID.\n\n**Params:**\n\n- `iccid` (integer, required)\n    \n    - The ICCID of the eSIM for which you want to retrieve the details. Obtained from the `/new_esim` endpoint\n        \n- `token` (string, required)\n    \n    - The access token, obtained from core.yesim.biz platform, should be included in the request parameters\n        \n\nExample Request:\n\n``` bash\ncurl --location 'https://partners-api.yesim.biz/sim_info?iccid=8937204017178106954&token=39c0b655-8433-4c21-84a7-9dc3b6814661-143fd6d0-654b-479b-98ab-7c7ee195e6e9'\n\n ```\n\n``` json\n{\n    \"id\": \"1806\",\n    \"iccid\": \"8937204017178106954\",\n    \"user_id\": \"405\",\n    \"created_at\": \"2024-10-11 06:47:15\",\n    \"active_plan_id\": \"8782\",\n    \"plan_activated_at\": \"2025-05-08 10:09:03\",\n    \"plan_expired_at\": \"2025-06-07 10:09:03\",\n    \"qrcode\": \"LPA:1$smdp.io$K2-26L4K8-1KB5J7I\",\n    \"status_qr\": \"Enabled\",\n    \"imsi\": \"260010199895775\",\n    \"msisdn\": null,\n    \"is_deleted\": \"0\",\n    \"data_left_mb\": 20440,\n    \"data_package_mb\": 20480,\n    \"data_used_mb\": 40,\n    \"img\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQMAAACXljzdAAAABlBMVEX///8AAABVwtN+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAA/klEQVRYhd2YwRKDMAhE4cv9c7aBBTXteHdLNOPwLt0BN1izxzhQsZ5gYb4uJuLdpH47ajnC18qE65LUieJUGktryJPc/4lQLGunTboTSyxK7FePapF2ilz1Xv14iBY5I7FvGUlyUOdsoPll+USJtVHkFvlmgbcomaIZSdyPJ0kypmdGk6CZK5NkVTun1OZvJgfzhYOG0GUTJWceXZfpQ1nChkP3GugKoUvQ00H5G8/S8Ws9MlH141xAoaLk4ClKoTOPxja/aRHqLK2+KxUl6AFhkf7aju37VJQsrVWzc0AQJ+jRwOZWJexEVCeGX8YnSsYpDIjrz6q7h0iRx/gAv7KqlVJEQZQAAAAASUVORK5CYII=\",\n    \"networkinfo\": {\n        \"time\": \"2025-05-08 10:16:37\",\n        \"lastMcc\": 257,\n        \"lastMnc\": 1,\n        \"lastRat\": \"4G - LTE\"\n    },\n    \"ios_tap_link\": \"https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.io$K2-26L4K8-1KB5J7I\"\n}\n\n ```\n\n#### Verify Purchase Order\n\nCheck the generated order by sending a request to `/orders`.\n\n**Example Request:**\n\n``` bash\ncurl --location 'https://partners-api.yesim.biz/orders?token=YOUR_API_TOKEN'\n\n ```\n\n**Response Example:**\n\n``` json\n//// Scroll to botton\n{\n    \"id\": \"344\",\n    \"user_id\": \"352\",\n    \"iccid\": \"8937204017178107143\",\n    \"plan_id\": \"6314\",\n    \"cost_eur\": \"0.55\",\n    \"created_at\": \"2025-03-28 10:41:41\",\n    \"payment_id\": \"1\"\n}\n\n ```\n\n#### User Account Creation\n\nTo create a user use `/new_user` request\n\n**Example Request:**\n\n``` bash\ncurl --location --request POST 'https://partners-api.yesim.biz/new_user?email=core_instr@gmail.com&token=YOUR_API_TOKEN' \\\n--data ''\n\n ```\n\n**Response Example:**\n\n``` json\n{\"user_id\":\"352\",\"email\":\"core_instr@gmail.com\"}\n\n ```\n\n#### **Assign eSIM**\n\nTo assign eSIM to the specific user use `/new_esim` endpoint and `user_id` parameter\n\n**Example Request:**\n\n``` bash\ncurl --location 'https://partners-api.yesim.biz/new_esim?token=YOUR_API_TOKEN&user_id=352'\n\n ```\n\n**Response Example:**\n\n``` json\n{\n\"id\":\"1825\",\n\"iccid\":\"8937204017178107143\",\n\"user_id\":\"352\",\n\"created_at\":\"2024-10-11 06:47:15\",\n\"active_plan_id\":null,\n\"plan_activated_at\":null,\n\"plan_expired_at\":null,\n\"qrcode\":\"LPA:1$smdp.io$K2-26L4KR-5PB4A8\",\n\"status_qr\":\"Released\",\n\"imsi\":\"260010199895794\",\n\"msisdn\":null,\n\"is_deleted\":\"0\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19324374","team":6366121,"collectionId":"f297adf9-1eb2-4c02-852b-b7d0ffec5ea0","publishedId":"2sA3kbgy28","public":true,"publicUrl":"https://documenter-api.postman.tech/view/19324374/2sA3kbgy28","privateUrl":"https://go.postman.co/documentation/19324374-f297adf9-1eb2-4c02-852b-b7d0ffec5ea0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Yesim provides an easy installation API for our Partners Program customers."},{"name":"title","value":"Yesim Partner API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2024-07-30T19:31:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Yesim Partner API","description":"Yesim provides an easy installation API for our Partners Program customers."},"logos":{"logoLight":null,"logoDark":null}},"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/236a422229f74224ecc2e099402740b510c74cca2223b182b73506d18e3a0723","favicon":""},"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://documenter.gw.postman.com/view/metadata/2sA3kbgy28"}