Import the Postman collection

Import the Samva email API into Postman from the OpenAPI spec and authenticate your requests with an API key.

Import the Samva API into Postman to test and explore the email endpoints from a request client. Postman builds the collection from the published OpenAPI spec, so it always reflects the current API.

Import the collection

Postman can build a collection directly from the OpenAPI spec.

Open Postman.
Click Import in the top left.
Select the Link tab.
Enter https://api.samva.app/v1/openapi.json.
Click Continue, then Import.

Authenticate the collection

Set your API key once at the collection level so every request inherits it.

Click the collection name in the sidebar.
Go to the Variables tab.
Add a variable named apiKey and set its value to your API key.
Click Save.

Then configure the collection's authorization:

Go to the Authorization tab.
Select API Key as the type.
Set Key to x-api-key.
Set Value to {{apiKey}}.
Set Add to to Header.

Requests authenticate with the x-api-key header. See API keys for details on creating and scoping keys.

Set up environments

Use Postman environments to switch between production and staging without editing requests.

// Production
{
  "baseUrl": "https://api.samva.app/v1",
  "apiKey": "samva_sk_live_your_api_key"
}

// Staging
{
  "baseUrl": "https://staging.api.samva.app/v1",
  "apiKey": "samva_sk_test_your_api_key"
}

Send a test request

Open the request for POST /v1/messages.

Set the body to an email send payload:

{
  "to": [{ "email": "ada@example.com" }],
  "channel": "email",
  "email": {
    "subject": "Welcome to Samva",
    "html": "<h1>Welcome!</h1>"
  }
}