Getting Started
This guide walks you through setting up your development environment and making your first request to the Sequifi API.
Prerequisites
Step 1: Obtain your API key
- Log in to the Sequifi Dashboard.
- Navigate to Settings → API Keys.
- Click Create API Key and give it a name (e.g. "Development").
- Copy the secret key. You won't be able to see it again.
Warning
Never share your API key or commit it to version control. Use environment variables in production.
Step 2: Make your first request
Use your API key in the Authorization header as a Bearer token:
curl https://api.sequifi.com/v1/me \
-H "Authorization: Bearer sk_live_your_api_key_here"You should receive a JSON response with your account details.
Step 3: Use the API in your app
Using cURL
curl -X POST https://api.sequifi.com/v1/resources \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "My Resource", "type": "example"}'Using JavaScript (fetch)
const response = await fetch('https://api.sequifi.com/v1/resources', {
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.SEQUIFI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ name: 'My Resource', type: 'example' }),
});
const data = await response.json();Using Node.js (axios)
const axios = require('axios');
const { data } = await axios.post(
'https://api.sequifi.com/v1/resources',
{ name: 'My Resource', type: 'example' },
{
headers: {
Authorization: `Bearer ${process.env.SEQUIFI_API_KEY}`,
'Content-Type': 'application/json',
},
}
);Base URL
| Environment | Base URL |
|---|---|
| Production | https://api.sequifi.com/v1 |
| Sandbox | https://api.sandbox.sequifi.com/v1 |
Next steps
- Read the Authentication guide for details on API keys and scopes.
- Explore the API Reference for all available endpoints.
- Set up Webhooks to receive real-time events.