Skip to content

Commit ef7b178

Browse files
committed
two files merged into one, improved formatting.
1 parent f1208c1 commit ef7b178

File tree

4 files changed

+36
-102
lines changed

4 files changed

+36
-102
lines changed

docs/troubleshooting/api/api_charset_and_encoding_fix_guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This guide shows you how to resolve such issues and ensure your API outputs are
1111

1212
Follow the steps below:
1313

14-
- **Set Proper Request Headers**
14+
1. **Set Proper Request Headers**
1515

1616
Make sure your API call includes the appropriate headers to instruct the server on how to format the response. Add the following headers to your API configuration:
1717

@@ -24,7 +24,7 @@ Follow the steps below:
2424

2525
![Setting Content-Type and Charset headers](../assets/20250430121409119593.png)
2626

27-
- **Enable UTF-8 Decoding in FlutterFlow**
27+
2. **Enable UTF-8 Decoding in FlutterFlow**
2828

2929
If the server does not specify encoding—or if you're still getting corrupted text—you can configure FlutterFlow to decode the API response as UTF-8 manually.
3030

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ title: Client-Server Errors during the API call
66
# Client-Server Errors During the API Call
77

88

9-
When calling an API in FlutterFlow, you may run into client-server errors. These typically come as status codes that indicate what went wrongeither on your end (the client) or on the server you're requesting data from.
9+
When calling an API in FlutterFlow, you may run into client-server errors. These typically come as status codes that indicate what went wrong, either on your end (the client) or on the server you're requesting data from.
1010

1111
This guide will help you understand the most common API error codes and how to fix them.
1212

13-
## What is an API?
14-
15-
An API (Application Programming Interface) lets two systems communicate with each other. When you make an API call, you're sending a request from your app (client) to a server, which responds with data.
13+
To learn more about APIs, check out our [API documentation guide](/resources/backend-logic/rest-api/).
1614

1715
## Common client-side status codes
1816

@@ -23,7 +21,7 @@ These errors are usually caused by incorrect requests from the client side.
2321
Your request isn’t properly formatted. This could be due to a missing parameter, a typo, or incorrect syntax.
2422

2523
:::tip
26-
Check the API documentation to ensure you're including the correct fields and headers.
24+
Check the API's own documentation to ensure you're including the correct fields and headers.
2725
:::
2826

2927
![400 Example](../assets/20250430121351345482.png)
@@ -90,7 +88,32 @@ These errors occur on the API server side.
9088

9189
The API server took too long to respond. Try simplifying your request or reducing the size of the data being sent.
9290

91+
92+
**Troubleshooting Steps**
93+
94+
- **Clear Browser Cache and Cookies**
95+
96+
If you're encountering a 400 Bad Request error, clearing your browser's cache and cookies can resolve issues related to expired or invalid data.
97+
98+
- **Verify the Requested URL**
99+
100+
Ensure the URL or endpoint is correct. Remember, domain names are case-sensitive.
101+
102+
- **Adjust Request Parameters**
103+
104+
For 400 errors, check if the file size is too large (for POST requests) or if there are any other incorrect parameters.
105+
106+
- **Consult API Documentation**
107+
108+
Always refer to the API's official documentation for specific requirements and troubleshooting tips.
109+
110+
- **Contact API Support**
111+
112+
If you continue to face issues, reaching out to the API's support team can provide further assistance and insights into resolving the problem.
113+
114+
Understanding these common API error status codes and their solutions can significantly smooth the development process, ensuring more efficient and effective communication between your application and the APIs you rely on.
115+
93116
:::tip[Final tips]
94-
- Always check the API documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.
95-
- Once you fix the issue, your calls should return a `200 OK`which means everything is working as expected!
117+
- Always check the API's own documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.
118+
- Once you fix the issue, your calls should return a `200 OK`, which means everything is working as expected!
96119
:::

docs/troubleshooting/api/securing_your_api_keys_in_private_api_calls.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ title: Securing Your API Keys in Private API Calls
88

99
Ensuring the security of API keys is a critical aspect of building and maintaining a safe and reliable application. In the realm of private API calls, it's especially important to make sure your API keys are not exposed. This article aims to provide a best-practices guide on where to place your API keys to increase security in a FlutterFlow environment.​
1010

11-
## The Misconception: Private API Calls Secure Everything
11+
**The Misconception: Private API Calls Secure Everything**
1212

13-
Many users assume that simply marking an API call as 'private' is enough to protect all associated data. However, this is not the case. Private API calls run in a Cloud Function, which means any keys or sensitive data in the body will be secure as long as they're not passed in from the frontend. Even in private API calls, if you're loading an API key from the frontend (like from Firebase remote configs), then you're still exposing it.​
13+
Many users assume that simply marking an API call as 'private' is enough to protect all associated data. However, this is not the case. Private API calls run in a Cloud Function, which means any keys or sensitive data in the body will be secure, as long as they're not passed in from the frontend. Even in private API calls, if you're loading an API key from the frontend (like from Firebase remote configs), then you're still exposing it.​
1414

15-
## Where to Put Your API Keys
15+
## Secure Placement of API Keys in Your Project
1616

1717
The ideal way to secure an API key is to include it in a request header or directly within the API endpoint URL. This ensures that it is never passed in from the client, thereby maintaining its confidentiality.​
1818

@@ -29,7 +29,7 @@ Many users assume that simply marking an API call as 'private' is enough to prot
2929
```
3030
The key should never be a variable that gets passed in from the frontend, as that would make it accessible via the client-side code, defeating the purpose of using private API calls for secure operations.
3131

32-
## How to verify that your key is secured
32+
## Verifying the Security of Your API Key
3333

3434
After implementing these changes, a straightforward way to verify that your key is secured is by downloading your application code and checking to make sure the API key doesn’t appear in any frontend files.​
3535

docs/troubleshooting/api/understanding_api_errors.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)