# Roamify API Documentation

> Welcome to the Roamify API documentation. This guide helps you authenticate, choose the correct environment, and integrate Roamify services into your product.

Canonical: https://docs.getroamify.com/

Welcome to the Roamify API documentation. This guide helps you authenticate, choose the correct environment, and integrate Roamify services into your product.

Roamify API is a REST API that allows you to buy eSIMs, manage eSIM lifecycle events, issue travel insurance policies, check partner balance, and work with exchange rates.

Currently, we support the following services:

- [Authentication](https://docs.getroamify.com/authentication/)
- [eSIMs](https://docs.getroamify.com/esims/overview/)
- [Insurance](https://docs.getroamify.com/insurance/overview/)
- [Exchange Rates](https://docs.getroamify.com/exchange-rates/overview/)
- [Health Check](https://docs.getroamify.com/health/)

If you need access or support, use the [Roamify Partner Portal](https://partner.getroamify.com/sign-up) or email [support@getroamify.com](mailto:support@getroamify.com).

## Getting Started
If this is your first time using Roamify API, follow the steps below:

1. Sign up or sign in via [Roamify Partner Portal](https://partner.getroamify.com/sign-in).
2. Get your Access Token from `API Keys`.
3. Pick your API environment:
  - Development: `https://api-dev.getroamify.com`
  - Production: `https://api.getroamify.com`
4. Read [Authentication](https://docs.getroamify.com/authentication/), then start with [eSIMs](https://docs.getroamify.com/esims/overview/).

## Resources

### Postman

We have created a Postman collection that you can import into your Postman app.
[Check Postman Collection](https://www.postman.com/roamifyhq/roamify-developers/overview)

### API Dog

We have also created an API Dog documentation for our API.
[Check API Dog](https://roamify.apidog.io/)

### Environments

We have two environments for our API:

- **Development**: Use this environment to test your integration with Roamify API.

  Endpoint: `https://api-dev.getroamify.com`

- **Production**: Use this environment when you are ready to go live with your application.

  Endpoint: `https://api.getroamify.com`