集成外部服务
学习将 Supabase 后端连接到第三方 API 和服务的模式,以扩展应用的功能
集成外部服务 是 CoddyKit 上的免费 Supabase Backend as a Service 课时。 这是第 1 节课,共 3 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Supabase Backend as a Service 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Supabase Backend as a Service 课程共包含 3 节课。
本课时的部分内容尚未翻译,以英文显示。
Why External Services?
Your app often needs to do more than just manage data in Supabase. Think about sending emails, processing payments, or integrating AI tools.
This is where integrating with external services comes in! It allows your Supabase backend to communicate with other APIs and platforms to extend your application's capabilities.
Common Integration Needs
Many common app features rely on external services:
- Payment Gateways: Stripe, PayPal for transactions.
- Email/SMS: SendGrid, Twilio for notifications.
- AI/ML APIs: OpenAI, Google Cloud AI for advanced features.
- Geo-location: Google Maps, Mapbox for mapping services.
- Analytics: Mixpanel, Segment for user behavior tracking.
Supabase's Role: Edge Functions
While your client-side app can call external APIs directly, for secure and backend-driven integrations, Supabase Edge Functions are your best friend.
Edge Functions act as serverless backend logic, running close to your users. They can make HTTP requests to any external API without exposing sensitive information directly in your client-side code.
Making an API Call with Deno
Supabase Edge Functions are built on Deno, which uses the standard fetch API for making network requests, similar to browsers. This makes it straightforward to interact with external services.
The flow is: your client invokes an Edge Function, which then makes a request to the external API, processes the response, and sends it back to your client.
Code Demo: Fetching External Data
Here's a simple Edge Function that fetches a random 'todo' item from a public API (JSONPlaceholder). Notice how we use Deno.serve as the entry point for the function.
import { serve } from 'https://deno.land/std@0.177.0/http/server.ts'
Deno.serve(async (req) => {
const { name } = await req.json()
try {
const response = await fetch('https://jsonplaceholder.typicode.com/todos/1')
const data = await response.json()
return new Response(JSON.stringify({
message: `Hello ${name}! Here's a todo: ${data.title}`,
}), {
headers: { 'Content-Type': 'application/json' },
status: 200,
})
} catch (error) {
return new Response(JSON.stringify({
error: error.message,
}), {
headers: { 'Content-Type': 'application/json' },
status: 500,
})
}
})Invoking the Edge Function
Once deployed, your client-side application can invoke this Edge Function using the Supabase client library. The function name here would be, for example, 'fetch-todo'.
The invoke method handles sending data to your function and receiving its response.
// Client-side JavaScript
async function getTodoFromEdgeFunction() {
try {
const { data, error } = await supabase.functions.invoke('fetch-todo', {
body: { name: 'CoddyKit User' },
})
if (error) {
console.error('Function error:', error)
} else {
console.log('Function response:', data)
}
} catch (err) {
console.error('Invocation error:', err)
}
}
// Call the function (e.g., on button click)
// getTodoFromEdgeFunction();Securing API Keys with Supabase Secrets
Hardcoding API keys directly into your Edge Function code is a security risk. If your code is ever exposed, your keys are compromised.
Supabase provides Secrets to securely store environment variables for your Edge Functions. These are not part of your codebase and are injected at runtime.
Using Secrets in Edge Functions
First, you'd set a secret using the Supabase CLI: supabase secrets set MY_EXTERNAL_API_KEY=your_key_here. Then, in your Edge Function, you access it via Deno.env.get('MY_EXTERNAL_API_KEY').
This keeps your sensitive credentials safe and out of your version control.
import { serve } from 'https://deno.land/std@0.177.0/http/server.ts'
Deno.serve(async (req) => {
// Access the secret environment variable
const apiKey = Deno.env.get('MY_EXTERNAL_API_KEY') || 'NO_KEY_SET'
// Example: Use the apiKey in a header for an external API call
// const response = await fetch('https://api.example.com/data', {
// headers: { 'Authorization': `Bearer ${apiKey}` },
// })
return new Response(JSON.stringify({
message: `API Key accessed: ${apiKey.substring(0, 5)}...`,
}), {
headers: { 'Content-Type': 'application/json' },
status: 200,
})
})Handling Responses & Errors Robustly
When integrating external services, always prepare for success and failure. Parse the API's response correctly (often JSON) and handle potential errors.
- Check HTTP Status: Not all 2xx responses are successes; some APIs use 4xx for business logic errors.
- Try-Catch Blocks: Essential for network errors or issues parsing responses.
- Meaningful Error Messages: Return clear error messages to the client without exposing internal API details.
Best Practices for Integrations
To ensure robust and scalable integrations:
- Rate Limiting: Respect external API rate limits to avoid getting blocked.
- Retries: Implement exponential backoff for transient network issues.
- Timeouts: Set reasonable timeouts for external requests to prevent hanging.
- Logging: Log requests and responses (especially errors) for debugging.
- Idempotency: Design your functions to handle duplicate requests gracefully for operations like payments.
Quick Check on Integration
You're building an Edge Function to send an email using an external email API. You need to include your email service API key.
Recap: Integrating External Services
You've learned how to extend your Supabase application's capabilities by integrating with external APIs and services.
- Edge Functions are ideal for secure backend-to-external-service communication.
- Use
fetchwithin Deno Edge Functions to make HTTP requests. - Always secure sensitive credentials like API keys using Supabase Secrets.
- Implement robust error handling and follow best practices for reliable integrations.
This opens up a world of possibilities for building powerful and feature-rich applications!
常见问题解答
「集成外部服务」课时是免费的吗?
是的 — 「集成外部服务」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Supabase Backend as a Service 课程的其余内容,请升级到 CoddyKit PRO。 Supabase Backend as a Service 课程共包含 3 节课。
「集成外部服务」这节课中我会学到什么?
学习将 Supabase 后端连接到第三方 API 和服务的模式,以扩展应用的功能 你通过在浏览器中直接运行的动手代码来练习 Supabase Backend as a Service,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Supabase Backend as a Service 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Supabase Backend as a Service 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 3 节。
「集成外部服务」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Supabase Backend as a Service 课中编写并运行代码吗?
能。每节 Supabase Backend as a Service 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。