cartodb-4.42/doc/developer-center/federated-tables-api/guides/02-general-concepts.md
2024-04-06 05:25:13 +00:00

18 lines
817 B
Markdown

**Warning:** Federated Tables is in **BETA** stage and the API might change or have limited support.
## General Concepts
The following concepts are the same for every endpoint in the API except when it is noted explicitly.
### Auth
Manipulating data on a CARTO account requires prior authentication using a unique identifier as a password. For the federated tables API, a special identifier known as the API Key is used as a proof of authentication for each user account to authorize access to its data.
To execute an authorized request, `api_key=YOURAPIKEY` should be added to the request URL. This parameter can be also passed as a POST parameter. We **strongly advise** using HTTPS when you are performing requests that include your `api_key`.
---
### Errors
Errors are reported using standard HTTP codes.