# Insomnia MailSlurp integration

Use MailSlurp email and SMS APIs in Insomnia REST client.

| Endpoint     | URL                                                                                                                                           |
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Run          | [![insomnia.svg](/assets/insomnia-run.svg)](https://insomnia.rest/run/?label=MailSlurp%20%28Basic%29&uri=https%3A%2F%2Fswagger.mailslurp.com) |
| Swagger Spec | [https://swagger.mailslurp.com](https://swagger.mailslurp.com)                                                                                |
| Get API KEY  | [https://app.mailslurp.com](https://app.mailslurp.com)                                                                                        |

## Set API Key authentication
Requests to MailSlurp must be authenticated with a MailSlurp API Key. There are several ways to do this:

### Set xApiKey environment variable
Set the `xApiKey` variable in the environment settings to your [MailSlurp API Key](https://app.mailslurp.com).

![insomnia-collection-set-env.jpeg](/assets/insomnia/insomnia-collection-set-env.jpeg)
![insomnia-set-api-key.jpeg](/assets/insomnia/insomnia-set-api-key.jpeg)

### Set x-api-key header
Alternatively, set the `x-api-key` header in the Auth tab of a request to use your [MailSlurp API Key](https://app.mailslurp.com).

![insomnia-request-auth.jpeg](/assets/insomnia/insomnia-request-auth.jpeg)

## Setup instructions
MailSlurp has an [OpenAPI specification](https://swagger.mailslurp.com) that can be imported into Insomnia as a document or a collection.

### Import document

1. Open [Insomnia](https://app.insomnia.rest/app/download) and click `Import` in the bottom left

![](/assets/insomnia/insomnia-1.jpeg)

2. Paste in the MailSlurp Swagger url: `https://swagger.mailslurp.com`

![](/assets/insomnia/insomnia-2.jpeg)

3. Click `Scan` to import the MailSlurp API collection.

![](/assets/insomnia/insomnia-specification.jpeg)

### Import collection
You can also import collections and execute requests.

1. In your collection click the `+` icon in the request tab

![insomnia-collection-1.jpeg](/assets/insomnia/insomnia-collection-1.jpeg)

2. Import the collection via the URL import of `https://swagger.mailslurp.com`

![insomnia-collection-2.jpeg](/assets/insomnia/insomnia-collection-2.jpeg)

3. Execute requests in the collection panel
   ![insomnia-collection-3.jpeg](/assets/insomnia/insomnia-collection-3.jpeg)