eSIM Go

https://docs.esim-go.com/
Admin
eSIM Go is a global telecom API that aggregates services and provides developers with easy access to...
Tokens:106,426
Snippets:725
Trust Score:6.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example First Installed Date/Time Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the date and time when the eSIM profile was first installed.

```text
2023-06-15T14:30:00.000Z
```

--------------------------------

### Example Bundle Start Time

Source: https://docs.esim-go.com/api/notifications/operations/utilisation/post

Provide the start time of the data bundle in ISO 8601 format.

```text
2006-01-02T15:04:05Z
```

--------------------------------

### Example JSON Response for eSIM Install Details

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Illustrates the structure of a successful JSON response containing eSIM install details.

```json
{
  "iccid": "8944123456789012345",
  "matchingId": "A1B2-C3D4-E5F6-G7H8",
  "smdpAddress": "http://smdp.example.com",
  "profileStatus": "Released",
  "pin": "1234",
  "puk": "12345678",
  "firstInstalledDateTime": "2023-06-15T14:30:00.000Z"
}
```

--------------------------------

### Retrieve eSIM Install Details using Node.js

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Node.js example uses the 'axios' library to retrieve eSIM installation details. Ensure 'axios' is installed. Replace '$API_KEY' with your actual API key.

```javascript
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.esim-go.com/v2.4/esims/assignments',
  headers: { 
    'X-API-Key': '$API_KEY', 
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Retrieve eSIM Install Details using cURL

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This example shows how to fetch eSIM installation details using cURL. It requires your API key and specifies JSON content type.

```shell
curl 'https://api.esim-go.com/v2.4/esims/assignments' \
-H 'X-API-Key: $API_KEY' \
-H 'Content-Type: application/json'
```

--------------------------------

### Get Bundle Details (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Go code example for retrieving bundle details. It sets up an HTTP client, creates a request, and includes necessary headers.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/catalogue/bundle/{name}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
```

--------------------------------

### GET Orders Request Example

Source: https://docs.esim-go.com/esim-go-24-postman.json

Example of a GET request to retrieve orders. Includes query parameters for filtering and pagination. Ensure your API Key is correctly set in the headers.

```http
GET {{baseUrl}}/orders?includeIccids=<boolean>&page=<integer>&limit=<integer>&createdAt=<string> HTTP/1.1
Host: {{baseUrl}}
Accept: application/json
X-API-Key: <API Key>
```

--------------------------------

### Retrieve Order Details using Node.js (Axios)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

A Node.js example using the Axios library to get order details. Remember to install Axios (`npm install axios`) and replace `$API_KEY` and `{orderReference}`.

```js
const axios = require('axios');

            let config = {
              method: 'get',
              maxBodyLength: Infinity,
              url: 'https://api.esim-go.com/v2.4/orders/{orderReference}',
              headers: { 
                'X-API-Key': '$API_KEY', 
                'Content-Type': 'application/json'
              }
            };

            axios.request(config)
            .then((response) => {
              console.log(JSON.stringify(response.data));
            })
            .catch((error) => {
              console.log(error);
            });
```

--------------------------------

### Retrieve eSIM Install Details using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go code snippet shows how to make a GET request to retrieve eSIM installation details. It sets up an HTTP client and constructs the request URL.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/assignments"
  method := "GET"

  client := &http.Client {
  }

```

--------------------------------

### Get Order Detail Example

Source: https://docs.esim-go.com/api/v2_5/operations/ordersorderreference/get

This example demonstrates how to retrieve the details of a completed order, including assigned eSIM information and cost breakdown.

```json
{
  "order": [
    {
      "esims": [
        {
          "iccid": "8912345678901234567",
          "matchingId": "AB-12C3DE-4FGHIJ5",
          "smdpAddress": "http://rsp.mockprovider.com"
        }
      ],
      "type": "bundle",
      "item": "esim_5GB_30D_EU_V3",
      "iccids": [
        "8912345678901234567"
      ],
      "quantity": 1,
      "subTotal": 9.99,
      "pricePerUnit": 9.99,
      "AllowReassign": true
    }
  ],
  "total": 9.99,
  "currency": "USD",
  "status": "completed",
  "statusMessage": "Order completed: 1 eSIMs assigned",
  "orderReference": "1a2b3c4d-5e6f-7g8h-9i10-11j12k13l14m",
  "createdDate": "2023-06-15T10:30:45.123456789Z",
  "assigned": true
}
```

--------------------------------

### GET eSIM Bundles Request Example

Source: https://docs.esim-go.com/esim-go-24-postman.json

This example shows a GET request to retrieve eSIM bundles for a specific ICCID. It includes headers for authentication and content type, and query parameters for filtering results.

```http
GET /esims/:iccid/bundles?includeUsed=<string>&limit=<string> HTTP/1.1
Host: {{baseUrl}}
Accept: application/json
X-API-Key: <API Key>
```

--------------------------------

### Get eSIM Bundle Information (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Fetch eSIM bundle data using Go's standard net/http package. This example demonstrates setting headers for authentication and content type.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/{iccid}/bundles/{name}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Get eSIM Install Details Request

Source: https://docs.esim-go.com/esim-go-24-postman.json

This GET request retrieves eSIM installation details using an API key for authentication. It supports various 'Accept' headers for different response formats, including CSV, JSON, and ZIP.

```http
GET {{baseUrl}}/esims/assignments?reference=<string>&additionalFields=<string> HTTP/1.1
Host: {{baseUrl}}
Accept: application/json
X-API-Key: {{apiKey}}
```

--------------------------------

### Get eSIM Bundles (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Demonstrates how to fetch available bundles for a specific eSIM using the Go programming language. Ensure you have the necessary HTTP client setup and replace '$API_KEY' with your actual API key.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/{iccid}/bundles"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundles/post

Example of a successful response when a bundle is applied to an eSIM.

```json
{
  "status": "<string>"
}
```

--------------------------------

### Get Bundle Details (cURL)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Example using cURL to fetch details for a specific bundle from the catalogue. Replace {name} with the actual bundle name.

```shell
curl -g 'https://api.esim-go.com/v2.4/catalogue/bundle/{name}' \
-H 'X-API-Key: $API_KEY' \
-H 'Content-Type: application/json'
```

--------------------------------

### Example Profile Name

Source: https://docs.esim-go.com/api/v2_5/operations/catalogue/get

This example shows a 'profileName' value that might be returned in the catalogue response.

```json
Profile 1
```

--------------------------------

### Retrieve eSIM Install Details using Httpie

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This snippet demonstrates fetching eSIM installation details with Httpie, a command-line HTTP client. It includes a timeout setting and requires your API key.

```shell
http --timeout 3600 GET 'https://api.esim-go.com/v2.4/esims/assignments' \
 X-API-Key:'$API_KEY' \
 Content-Type:'application/json'
```

--------------------------------

### Example Initial Bundle Quantity

Source: https://docs.esim-go.com/api/notifications/operations/utilisation/post

Specify the initial total data quantity of the bundle in bytes.

```text
1000000000
```

--------------------------------

### Get eSIM History (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Retrieve eSIM history in Go. This example demonstrates making a GET request with necessary headers.

```go
package main

            import (
              "fmt"
              "net/http"
              "io/ioutil"
            )

            func main() {

              url := "https://api.esim-go.com/v2.4/esims/{iccid}/history"
              method := "GET"

              client := &http.Client {
              }
              req, err := http.NewRequest(method, url, nil)

              if err != nil {
                fmt.Println(err)
                return
              }
              req.Header.Add("X-API-Key", "$API_KEY")
              req.Header.Add("Content-Type", "application/json")

              res, err := client.Do(req)
              if err != nil {
                fmt.Println(err)
                return
              }
              defer res.Body.Close()

              body, err := ioutil.ReadAll(res.Body)
              if err != nil {
                fmt.Println(err)
                return
              }
              fmt.Println(string(body))
            }
```

--------------------------------

### Get eSIM Location using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Fetch eSIM location details using Go's standard net/http package. This example demonstrates making a GET request with necessary headers.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/{iccid}/location"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Example Bundle Name

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundlesname/get

This is an example of a bundle name that can be used in the request. Bundle names are case-sensitive.

```text
esim_1GB_7D_REUP_V2
```

--------------------------------

### Get eSIM Response Example (JSON)

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccid/get

Example JSON response when retrieving eSIM details, including fields like ICCID, MSISDN, PIN, PUK, matchingId, smdpAddress, profileStatus, firstInstalledDateTime, customerRef, appleInstallUrl, androidInstallUrl, brandingId, profileName, and state.

```json
{
  "iccid": "894123456789123456",
  "msisdn": "4471234131234",
  "pin": "0000",
  "puk": "123445678",
  "matchingId": "JQ-123456-ABCDEPFX",
  "smdpAddress": "http://rsp.example.com",
  "profileStatus": "Installed",
  "firstInstalledDateTime": 1723541877280,
  "customerRef": "",
  "appleInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$rsp-1234.example.com$ABCD-ABCD-ABCD-ABCD",
  "androidInstallUrl": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$rsp-1234.example.com$ABCD-ABCD-ABCD-ABCD",
  "brandingId": "f616f7g8-ey0d-123d-803d-0214a2f5dafb",
  "profileName": "Profile 1",
  "state": "active"
}
```

--------------------------------

### eSIM Install Details Response (ZIP)

Source: https://docs.esim-go.com/esim-go-24-postman.json

When requesting 'application/zip', the response is a ZIP file containing QR code images in PNG format for eSIM installation.

```zip
Response is a ZIP file containing QR code images in PNG format.
```

--------------------------------

### API Key Authentication Example

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This example demonstrates how to authenticate with the eSIMGo API using an API Key passed in the HTTP header. It shows the 'curl' command format for including the 'X-API-Key' header.

```bash
curl -H 'X-API-Key: $API_KEY' https://api.esim-go.com/v2.3/esims/$ICCID/bundles
```

--------------------------------

### Get eSIMs CSV Example

Source: https://docs.esim-go.com/api/v2_5/operations/esimscsvreference/get

Example of the CSV response format containing eSIM details like ICCID, Matching ID, RSP URL, and Bundle. This is returned when the request is successful.

```csv
"ICCID","Matching ID","RSP URL","Bundle"
"Value 1","Value 2","Value 3","Value 4"
```

--------------------------------

### eSIM Install Details Response (JSON)

Source: https://docs.esim-go.com/esim-go-24-postman.json

This is a successful JSON response for retrieving eSIM installation details. It includes ICCID, matching ID, SMDP address, profile status, PIN, PUK, and installation date.

```json
{
  "iccid": "<string>",
  "matchingId": "<string>",
  "smdpAddress": "<string>",
  "profileStatus": "<string>",
  "pin": "<string>",
  "puk": "<string>",
  "firstInstalledDateTime": "<dateTime>"
}
```

--------------------------------

### Fetch Organization Bundle Groups using Node.js (axios)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Node.js example uses the axios library to make a GET request for organization bundle groups. Remember to replace `$API_KEY` with your API key.

```js
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.esim-go.com/v2.4/organisation/groups',
  headers: { 
    'X-API-Key': '$API_KEY', 
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Example additionalFields parameter

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Demonstrates the usage of the 'additionalFields' query parameter.

```text
installUrl
```

--------------------------------

### Get eSIM Install Details

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Retrieves eSIM SMDP+ details by providing one or more reference numbers. The response format can be controlled via the 'Accept' header.

```APIDOC
## GET /esims/assignments

### Description
Retrieves eSIM SMDP+ details based on provided Order or Apply References. Supports multiple reference numbers and various output formats (CSV, JSON, ZIP).

### Method
GET

### Endpoint
/esims/assignments

### Parameters
#### Query Parameters
- **reference** (string) - Required - Order Reference or Apply Reference
- **additionalFields** (string) - Optional - Example: `installUrl`

### Responses
#### Success Response (200)
Select media type: `application/json`
- **iccid** (string) - The ICCID (Integrated Circuit Card Identifier) of the eSIM
- **matchingId** (string) - The matching ID for the eSIM profile
- **smdpAddress** (string) - The address of the Subscription Manager Data Preparation (SM-DP+) server
- **profileStatus** (string) - The current status of the eSIM profile
- **pin** (string) - The PIN (Personal Identification Number) for the eSIM
- **puk** (string) - The PUK (PIN Unlock Key) for the eSIM
- **firstInstalledDateTime** (string) - The date and time when the profile was first installed (format: date-time)

#### Response Example (200 - application/json)
```json
{
  "iccid": "8944123456789012345",
  "matchingId": "A1B2-C3D4-E5F6-G7H8",
  "smdpAddress": "http://smdp.example.com",
  "profileStatus": "Released",
  "pin": "1234",
  "puk": "12345678",
  "firstInstalledDateTime": "2023-06-15T14:30:00.000Z"
}
```

#### Error Responses
- **400** Bad Request - Returned when request format is not accepted.
- **403** Unauthorised - Returned when the API token is invalid, the user has no available Bundles left, or the ICCID is not accessible.
- **410** Gone - Returned when the eSIM has been deactivated.
- **429** Too Many Requests
- **500** Server Error
- **503** Processing - Please come back later or use the _Retry-After_ (seconds) header.
```

--------------------------------

### Organisation Details Response Example

Source: https://docs.esim-go.com/api/v2_5/operations/organisation/get

Example of a successful JSON response containing organisation details.

```json
{
  "name": "Acme Corp",
  "apiKey": "ak_1234567890abcdef",
  "taxLiable": "Yes",
  "addr1": "123 Main St",
  "addr2": "Suite 456",
  "city": "Metropolis",
  "country": "USA",
  "postcode": "12345",
  "callbackUrl": "https://api.acmecorp.com/callback",
  "notes": "Premium customer",
  "groups": [
    "Enterprise",
    "Tech"
  ],
  "currency": "USD",
  "balance": 10000,
  "testCredit": 500,
  "testCreditExpiry": "2023-12-31",
  "businessType": "Corporation",
  "website": "https://www.acmecorp.com",
  "productDescription": "Cloud computing services",
  "users": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "role": "Admin",
      "emailAddress": "{EMAIL}",
      "phoneNumber": "+1 (555) 123-4567",
      "timeZone": "America/New_York"
    }
  ]
}
```

--------------------------------

### Query Parameter Example: Customer Reference

Source: https://docs.esim-go.com/api/v2_5/operations/esims/put

Example of a customer reference value for the query parameter.

```text
Test
```

--------------------------------

### Example Response for 200 OK

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundles/get

A successful response includes an array of bundles, each with its name, description, and assignments.

```json
{
  "bundles": [
    {
      "name": "esim_1GB_7D_GB_V2",
      "description": "eSIM, 1GB, 7 Days, United Kingdom, V2",
      "assignments": [
        {
          "id": "215009266",
          "callTypeGroup": "data",
          "initialQuantity": 1000000000,
          "remainingQuantity": 1000000000,
          "assignmentDateTime": "2024-12-11T10:47:00.34523Z",
          "assignmentReference": "3a6e2e40-c674-45e9-b289-b35027bf72a9-0",
          "bundleState": "queued",
          "unlimited": false
        }
      ]
    }
  ]
}
```

--------------------------------

### List eSIMs Example

Source: https://docs.esim-go.com/api/v2_5/operations/esims/get

This example demonstrates how to retrieve a list of eSIMs. It shows the structure of a successful JSON response containing an array of eSIM objects, each with details like ICCID, customer reference, and state.

```json
{
  "esims": [
    {
      "iccid": "8901234567890123456",
      "customerRef": "CUST001",
      "lastAction": "Bundle Applied",
      "actionDate": "2023-05-15T14:30:00Z",
      "physical": false,
      "assignedDate": "2023-05-01T10:00:00Z",
      "state": "active"
    },
    {
      "iccid": "8909876543210987654",
      "customerRef": "CUST002",
      "lastAction": "Activated",
      "actionDate": "2023-05-16T09:15:00Z",
      "physical": true,
      "assignedDate": "2023-05-10T11:30:00Z",
      "state": "suspended"
    }
  ]
}
```

--------------------------------

### Successful Topup Response Example

Source: https://docs.esim-go.com/api/v2_5/operations/organisationbalance/post

Example of a successful response after topping up an organization's balance. Includes the amount of the top-up, the new current balance, and a transaction reference number.

```json
{
  "amount": 5000,
  "balance": 12500,
  "ref": 987654321
}
```

--------------------------------

### Example SMDP Address Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the SMDP+ server address returned in a successful response.

```text
http://smdp.example.com
```

--------------------------------

### Retrieve eSIM Bundle Catalogue using Node.js (Axios)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Node.js example uses the Axios library to make a GET request to the catalogue endpoint. It shows how to configure the request headers and handle the response or errors.

```js
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.esim-go.com/v2.4/catalogue',
  headers: { 
    'X-API-Key': '$API_KEY', 
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### eSIM Install Details Response (CSV)

Source: https://docs.esim-go.com/esim-go-24-postman.json

This is a successful CSV response for retrieving eSIM installation details. The format is default when 'Accept' header is not specified or set to 'text/csv'.

```csv
iccid,matchingId,smdpAddress,profileStatus,pin,puk,firstInstalledDateTime
<string>,<string>,<string>,<string>,<string>,<string>,<dateTime>
```

--------------------------------

### Example New Amount

Source: https://docs.esim-go.com/api/notifications/operations/topup/post

Represents the organization's balance after a topup.

```text
90.1
```

--------------------------------

### Example Profile Status Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the eSIM profile status returned in a successful response.

```text
Released
```

--------------------------------

### Example Compatibility Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidcompatiblebundle/get

Shows a JSON response indicating that an eSIM and bundle are not compatible.

```json
{
  "compatible": false
}
```

--------------------------------

### Example Bundle Name

Source: https://docs.esim-go.com/api/notifications/operations/utilisation/post

Indicate the name of the data bundle for which usage is being reported.

```text
A_BUNDLE_1GB
```

--------------------------------

### Example PIN Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the PIN for the eSIM returned in a successful response.

```text
1234
```

--------------------------------

### Example Unlimited Bundle Status

Source: https://docs.esim-go.com/api/notifications/operations/utilisation/post

Set to true if the bundle has unlimited data, false otherwise.

```text
false
```

--------------------------------

### Example Matching ID Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the matching ID returned in a successful response.

```text
A1B2-C3D4-E5F6-G7H8
```

--------------------------------

### Response Example: Success

Source: https://docs.esim-go.com/api/v2_5/operations/esims/put

JSON object indicating a successful update operation.

```json
{
  "status": "success"
}
```

--------------------------------

### Created At Parameter Example

Source: https://docs.esim-go.com/api/v2_5/operations/orders/get

Specifies the date range for filtering orders. Use 'lte:' prefix to specify the end date. For example, to query orders from March 1, 2024, to March 31, 2024, use `createdAt=gte:2024-03-01T00:00:00.000Z&createdAt=lte:2024-03-31T23:59:59.999Z`.

```text
<dateTime>
```

--------------------------------

### Get eSIM Location using Python

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Python script uses the requests library to get the location of an eSIM. Ensure the 'requests' library is installed (`pip install requests`).

```python
import requests
import json

url = "https://api.esim-go.com/v2.4/esims/{iccid}/location"

payload = {}
headers = {
  'X-API-Key': '$API_KEY',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Send SMS to eSIM (Python Example)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Python example demonstrates how to send an SMS message to an eSIM using the ESIM Go API. It includes setting the message content and sender information.

```python
import requests
            import json

            url = "https://api.esim-go.com/v2.4/esims/{iccid}/sms"

            payload = {
                "message": "Hello!",
                "from": "eSIM"
            }
            headers = {
              'X-API-Key': '$API_KEY',
              'Content-Type': 'application/json',
              'Accept': 'application/json'
            }

            response = requests.request("POST", url, headers=headers, data=json.dumps(payload))

            print(response.text)
```

--------------------------------

### Apply Bundle to eSIM using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program shows how to make a POST request to apply a bundle to an eSIM. It includes setting the necessary headers and reading the response. Replace `$API_KEY` with your actual API key.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/apply"
  method := "POST"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }

```

--------------------------------

### Example Page Parameter

Source: https://docs.esim-go.com/api/v2_5/operations/catalogue/get

Demonstrates how to specify the 'page' query parameter to retrieve a specific page of bundle results.

```http
GET /catalogue?page=1
```

--------------------------------

### Example Old Amount

Source: https://docs.esim-go.com/api/notifications/operations/topup/post

Represents the organization's balance before a topup.

```text
40.1
```

--------------------------------

### Balance Threshold Notification Example

Source: https://docs.esim-go.com/api/notifications/operations/balancethreshold/post

This example demonstrates the structure of a request body for a low balance notification. It includes the alert type, current balance, the organization's low balance threshold, and the percentage of the threshold remaining.

```json
{
  "alertType": "LowBalance",
  "balanceInfo": {
    "balance": 1299.3,
    "threshold": 2600,
    "thresholdPercentRemaining": 49.973
  }
}
```

--------------------------------

### Make HTTP GET Request in Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go snippet demonstrates how to make an HTTP GET request to the ESIM Go API, including setting necessary headers like 'X-API-Key' and 'Content-Type'. It also shows how to read and print the response body.

```go
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
  fmt.Println(err)
  return
}
req.Header.Add("X-API-Key", "$API_KEY")
req.Header.Add("Content-Type", "application/json")

res, err := client.Do(req)
if err != nil {
  fmt.Println(err)
  return
}
defer res.Body.Close()

body, err := ioutil.ReadAll(res.Body)
if err != nil {
  fmt.Println(err)
  return
}
fmt.Println(string(body))
```

--------------------------------

### Get Bundle Details (Httpie)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Demonstrates fetching bundle details using Httpie. Ensure the correct headers and URL are provided.

```shell
http --timeout 3600 GET 'https://api.esim-go.com/v2.4/catalogue/bundle/{name}' \
X-API-Key:'$API_KEY' \
Content-Type:'application/json'
```

--------------------------------

### Example Alert Type

Source: https://docs.esim-go.com/api/notifications/operations/utilisation/post

Specify 'Utilisation' as the alert type for eSIM data usage.

```text
Utilisation
```

--------------------------------

### Retrieve eSIM Bundle Catalogue using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to fetch the eSIM bundle catalogue using the standard `net/http` package. It sets up the client, URL, and method for the GET request.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/catalogue"
  method := "GET"

  client := &http.Client {
  }

```

--------------------------------

### Refresh eSIM Request Example

Source: https://docs.esim-go.com/esim-go-24-postman.json

Example of a GET request to refresh an eSIM. Ensure the 'X-API-Key' header is included for authentication and the correct ICCID is provided in the URL.

```http
GET {{baseUrl}}/esims/:iccid/refresh
Accept: application/json
X-API-Key: {{apiKey}}
```

--------------------------------

### First Use Notification Example

Source: https://docs.esim-go.com/api/notifications/operations/firstuse/post

Example of the JSON payload for a FirstUse notification. This notification is sent when an eSIM first uses data, signaling the start of a bundle and its duration.

```json
{
  "alertType": "FirstUse",
  "iccid": 8944538532008160000,
  "bundle": {
    "name": "A_BUNDLE_1GB",
    "initialQuantity": 1000000000,
    "remainingQuantity": 1000000000,
    "startTime": "2006-01-02T15:04:05Z",
    "endTime": "2007-01-02T15:04:05Z"
  }
}
```

--------------------------------

### Fetch Inventory Data using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to fetch inventory data using the standard net/http package. Remember to replace $API_KEY with your actual API key.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/inventory"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Get eSIM Location using Node.js (axios)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Retrieve eSIM location data using Node.js with the axios library. Ensure you have axios installed (`npm install axios`).

```js
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.esim-go.com/v2.4/esims/{iccid}/location',
  headers: { 
    'X-API-Key': '$API_KEY', 
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Apply Bundle to eSIM (Httpie)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Demonstrates applying a bundle to an eSIM using the Httpie command-line tool. Ensure you replace '$API_KEY' and '{iccid}' with your actual credentials and the target eSIM's identifier.

```shell
printf '{"name":"string","startTime":"string","repeat":0}'| http  --timeout 3600 POST 'https://api.esim-go.com/v2.4/esims/{iccid}/bundles' \
 X-API-Key:'$API_KEY' \
 Content-Type:'application/json'
```

--------------------------------

### Example PerPage Parameter

Source: https://docs.esim-go.com/api/v2_5/operations/catalogue/get

Shows how to use the 'perPage' query parameter to control the number of bundles returned per page.

```http
GET /catalogue?perPage=50
```

--------------------------------

### Get eSIM Location Response Example

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidlocation/get

This is an example of a successful response (200 OK) when retrieving the location of an eSIM. It includes the mobile network code, network name, brand name, country, and the last seen timestamp.

```json
{
  "mobileNetworkCode": "FRAF1",
  "networkName": "Orange",
  "networkBrandName": "Orange France",
  "country": "FR",
  "lastSeen": "2024-07-27T00:25:07.382562Z"
}
```

--------------------------------

### Fetch Catalogue Data (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Demonstrates how to fetch catalogue data using Go's http package. Ensure proper error handling and response body reading.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/catalogue"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Request Body Example

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundles/post

Defines the structure for the request body when applying a bundle to an eSIM. Includes name, start time, and repeat count.

```json
{
  "name": "<string>",
  "startTime": "<string>",
  "repeat": "<integer>"
}
```

--------------------------------

### Get Bundle Groups

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Retrieves a list of available bundle groups for the organization, categorized by account tier. The example shows groups for the standard tier.

```APIDOC
## GET /v2.4/organisation/groups

### Description
Retrieves a list of available bundle groups for the organization. The structure of these groups depends on the account tier. The example provided illustrates the groups for a 'standard' organization tier.

### Method
GET

### Endpoint
/v2.4/organisation/groups

### Parameters
#### Header Parameters
- **Accept** (string) - Example: application/json
- **X-API-Key** (string) - Required - API key for authentication.

### Request Example
```shell
curl 'https://api.esim-go.com/v2.4/organisation/groups' \
-H 'X-API-Key: $API_KEY' \
-H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **groups** (array) - A list of bundle group objects.
  - **name** (string) - The name of the bundle group.

#### Response Example
```json
{
  "groups": [
    {
      "name": "Standard Fixed Bundles"
    },
    {
      "name": "Standard Unlimited Bundles"
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: Returned when the request format is not accepted.
- **403 Unauthorised**: Returned when the API token is invalid, the user has no available Bundles left, or the ICCID is not accessible by the user.
- **429 Too Many Requests**: Returned when the rate limit has been exceeded.
- **500 Server Error**: Returned when a server-side error occurs.
- **503 Processing**: Returned when the service is temporarily unavailable; please try again later. A 'Retry-After' header may be provided.
```

--------------------------------

### Get Country Network Data (cURL)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Example using cURL to retrieve network data for countries. Sets the API key and content type headers for the request.

```shell
curl 'https://api.esim-go.com/v2.4/networks' \
-H 'X-API-Key: $API_KEY' \
-H 'Content-Type: application/json'
```

--------------------------------

### Apply Bundle to eSIM using Httpie

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Httpie command demonstrates how to apply a bundle to an eSIM. Remember to substitute `$API_KEY` with your valid API key.

```shell
http --timeout 3600 POST 'https://api.esim-go.com/v2.4/esims/apply' \
 X-API-Key:'$API_KEY' \
 Content-Type:'application/json'
```

--------------------------------

### Apply Bundle to eSIM (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Applies a bundle to an eSIM using the ESIM Go API in Go. This example demonstrates setting up the HTTP request, including headers and payload, and handling the response.

```go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/esims/{iccid}/bundles"
  method := "POST"

  payload := strings.NewReader(`{"name":"string","startTime":"string","repeat":0}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Get Applied Bundle Status (Example)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Retrieves the status of a specific bundle applied to an eSIM. Bundle names are case-sensitive. The response includes details like remaining data and assignment dates.

```json
{
  "assignments": [
    {
      "id": "215009266",
      "callTypeGroup": "data",
      "initialQuantity": 1000000000,
      "remainingQuantity": 1000000000,
      "assignmentDateTime": "2024-12-11T10:47:00.34523Z"
    }
  ]
}
```

--------------------------------

### Validate and Create Order with Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to validate and create an order using the standard 'net/http' package. Ensure your API key is correctly set.

```go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/orders"
  method := "POST"

  payload := strings.NewReader(`{"type":"validate","assign":true,"Order":[{"type":"bundle","quantity":0,"item":"string","iccids":["string"],"allowReassign":true}]}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Example ICCID

Source: https://docs.esim-go.com/api/notifications/operations/firstattachment/post

An example ICCID for an eSIM.

```text
8944538532008160222
```

--------------------------------

### Fetch Organization Bundle Groups using Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to fetch organization bundle groups using the standard net/http package. Ensure you have a valid API key.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/organisation/groups"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }

```

--------------------------------

### Example Assignment ID

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundlesnameassignmentsassignmentid/delete

Provides an example of an assignment ID.

```text
123231231
```

--------------------------------

### Example ICCID Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the ICCID returned in a successful response.

```text
8944123456789012345
```

--------------------------------

### Example PUK Response

Source: https://docs.esim-go.com/api/v2_5/operations/esimsassignments/get

Provides an example of the PUK for the eSIM returned in a successful response.

```text
12345678
```

--------------------------------

### Example Hash Value

Source: https://docs.esim-go.com/api/v2_5/operations/catalogueprices/get

This is an example of the SHA256 hash value returned for change detection.

```json
a1b2c3d4e5f6...
```

--------------------------------

### Check eSIM Compatibility (Go)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to make an HTTP GET request to check eSIM compatibility. It includes setting the necessary headers and reading the response body.

```go
package main

            import (
              "fmt"
              "net/http"
              "io/ioutil"
            )

            func main() {

              url := "https://api.esim-go.com/v2.4/esims/{iccid}/compatible/{bundle}"
              method := "GET"

              client := &http.Client {
              }
              req, err := http.NewRequest(method, url, nil)

              if err != nil {
                fmt.Println(err)
                return
              }
              req.Header.Add("X-API-Key", "$API_KEY")
              req.Header.Add("Content-Type", "application/json")

              res, err := client.Do(req)
              if err != nil {
                fmt.Println(err)
                return
              }
              defer res.Body.Close()

              body, err := ioutil.ReadAll(res.Body)
              if err != nil {
                fmt.Println(err)
                return
              }
              fmt.Println(string(body))
            }
```

--------------------------------

### Retrieve eSIMs using Httpie

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Fetch a list of eSIMs using the Httpie command-line tool. This example demonstrates setting the API key and content type headers.

```shell
http --timeout 3600 GET 'https://api.esim-go.com/v2.4/esims' \
 X-API-Key:'$API_KEY' \
 Content-Type:'application/json'
```

--------------------------------

### Bad Request Response Example

Source: https://docs.esim-go.com/api/v2_5/operations/organisation/get

Example of a 400 Bad Request response when the request format is not accepted.

```json
{
  "message": "Status of api functions which do not return data"
}
```

--------------------------------

### eSIM Install Details Response (Bad Request)

Source: https://docs.esim-go.com/esim-go-24-postman.json

This response indicates a bad request, typically returned when the request format is not accepted by the server.

```json
{
  "code": 400,
  "message": "Bad Request"
}
```

--------------------------------

### Apply Bundle to eSIM (JavaScript)

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

Applies a bundle to an eSIM using the ESIM Go API. Requires an API key and specifies bundle details like name, start time, and repeat interval.

```javascript
var config = {
    method: 'post',
    url: 'https://api.esim-go.com/v2.4/esims/{iccid}/bundles',
    headers: {
      'X-API-Key': '$API_KEY',
      'Content-Type': 'application/json'
    },
    data : data
  };

  axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });
```

--------------------------------

### Example Query Parameter: type=validate

Source: https://docs.esim-go.com/api/v2_5/operations/esimsiccidbundlesnameassignmentsassignmentid/delete

Example of using the 'type' query parameter to validate the revoke action without executing it.

```text
validate
```

--------------------------------

### Location Update Notification Example

Source: https://docs.esim-go.com/api/notifications/operations/locationupdate/post

This is an example of the JSON payload for a `CountryChange` alert, indicating an eSIM has registered in a new country.

```json
{
  "alertType": "CountryChange",
  "iccid": 8944538532008160000,
  "country": {
    "code": "NO",
    "name": "Norway"
  }
}
```

--------------------------------

### Get Bundle Inventory Request

Source: https://docs.esim-go.com/esim-go-24-postman.json

This GET request retrieves all purchased bundles and their remaining usages for an organization. It requires an 'Accept' header and an 'X-API-Key' for authentication.

```http
GET {{baseUrl}}/inventory
Accept: application/json
X-API-Key: {{apiKey}}
```

--------------------------------

### Send SMS Request Example

Source: https://docs.esim-go.com/esim-go-24-postman.json

This is an example of a POST request to send an SMS to a specific eSIM using its ICCID. It includes authentication, headers, and the request body.

```http
POST {{baseUrl}}/esims/:iccid/sms
Host: {{baseUrl}}
Content-Type: application/json
Accept: application/json
X-API-Key: {{apiKey}}

{
  "message": "message",
  "from": "eSIM"
}
```

--------------------------------

### Get Organization Balance with Go

Source: https://docs.esim-go.com/esim_go_schema_v2_4.yaml

This Go program demonstrates how to retrieve the organization's balance using the standard net/http package. Ensure your API key is correctly set in the X-API-Key header.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.esim-go.com/v2.4/organisation/balance"
  method := "POST"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-Key", "$API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```
Tokens:
Raw