github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.4 KiB
Plaintext
131 lines
4.4 KiB
Plaintext
---
|
|
title: APIen yleiskatsaus
|
|
info: Ymmärrä neljä erilaista APIa ja milloin käyttää kutakin.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Opi yhdistämään Twenty muihin työkaluihisi.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Twenty on suunniteltu kehittäjäystävälliseksi, tarjoten tehokkaita APIa, jotka mukautuvat mukautettuun tietomalliisi. Tarjoamme neljä erilaista API-tyyppiä erilaisten integrointitarpeiden täyttämiseksi.
|
|
|
|
## Kehittäjäkeskeinen lähestymistapa
|
|
|
|
Twenty luo APIa erityisesti datamallillesi, mikä tarkoittaa:
|
|
|
|
- **Ei pitkiä ID-tunnuksia**: Käytä objektien ja kenttien nimiä suoraan päätepisteissä
|
|
- **Vakiintuneet ja mukautetut objektit samalla viivalla**: Mukautettuja objektejasi käsitellään samalla tavalla kuin sisäänrakennettuja
|
|
- **Omistetut päätepisteet**: Jokainen objekti ja kenttä saa oman API-päätepisteensä
|
|
- **Mukautettu dokumentaatio**: Luotu erityisesti työtilasi tietomallille
|
|
|
|
<Warning>
|
|
Mukautettu API luo henkilökohtaistettua dokumentaatiota, joka on saavutettavissa Asetukset → API & Webhooks, kun API-avain on luotu. Tämä dokumentaatio heijastaa tarkkaa tietomalliasi ja kenttäkokoonpanojasi.
|
|
</Warning>
|
|
|
|
## Neljä API-tyyppiä
|
|
|
|
Twenty tarjoaa APIa sekä **REST** että **GraphQL** muodoissa:
|
|
|
|
### REST-API:t
|
|
|
|
#### 1. REST-Metadata-API
|
|
|
|
- **Tarkoitus**: Hallinnoi työtilaasi ja tietomallin rakennetta
|
|
- **Käyttötapaukset**:
|
|
- Luo, muokkaa tai poista objekteja ja kenttiä
|
|
- Määritä työtilan asetukset
|
|
- Hallinnoi datamallin suhteita
|
|
- **Käyttöönotto**: Saatavilla REST-päätepisteiden kautta
|
|
|
|
#### 2. REST-ydin-API
|
|
|
|
- **Tarkoitus**: Hallinnoi varsinaisia tietueitasi
|
|
- **Käyttötapaukset**:
|
|
- Luo, lue, päivitä, poista tietueita
|
|
- Etsi erityistä tietoa
|
|
- Hallinnoi tietueiden suhteita
|
|
- **Käyttöönotto**: Saatavilla REST-päätepisteiden kautta
|
|
|
|
### GraphQL API:t
|
|
|
|
#### 3. GraphQL-Metadata-API
|
|
|
|
- **Tarkoitus**: Sama kuin REST-Metadata-API, mutta GraphQL:n edut
|
|
- **Käyttötapaukset**: Sama työtila ja tietomallin hallinta
|
|
- **Lisäedut**:
|
|
- Etsi useita metatietotyyppejä yhdessä pyynnössä
|
|
- Tarkka kenttien valinta
|
|
- Parempi suorituskyky monimutkaisissa kyselyissä
|
|
|
|
#### 4. GraphQL Core API
|
|
|
|
- **Tarkoitus**: Sama kuin REST-ydin-API, mutta GraphQL:n edut
|
|
- **Käyttötapaukset**: Sama tietuehallinta
|
|
- **Lisäedut**:
|
|
- **Erätoiminnot**: Saatavilla kaikkiin operaatioihin
|
|
- **Upsert-toiminnot**: Luo tai päivitä tietueita yhdellä kerralla
|
|
- Kysely suhteiden yhdistetyt pyynnöt
|
|
- Tarkka tietojen haku
|
|
|
|
## Erätoiminnot
|
|
|
|
### REST- ja GraphQL-erätuki
|
|
|
|
Sekä REST- että GraphQL-API:t tukevat erätoimintoja suurimmalle osalle toiminnoista:
|
|
|
|
- **Eräkoko**: Enintään 60 tietuetta per pyyntö
|
|
- **Saatavilla olevat toiminnot**: Luo, päivitä, poista useita tietueita
|
|
- **Suorituskyky**: Merkittävästi nopeampi kuin yksittäiset API-kutsut
|
|
|
|
### Vain GraphQL-ominaisuudet
|
|
|
|
- **Eräupsert**: Saatavilla vain GraphQL API:lle
|
|
- **Käyttö**: Käytä monikon objektinimiä (esim. `CreateCompanies` `CreateCompany`:n sijasta)
|
|
- **Vaatimus**: Tämä on syy, miksi yksittäis- ja monikko-objektinimien tulee olla erilaisia
|
|
|
|
## API-dokumentaation saatavuus
|
|
|
|
1. Mene **Asetukset → API & Webhooks**
|
|
2. Luo API-avain (vaaditaan dokumentaation läpäisyyn)
|
|
3. Pääse käyttämään mukautettua dokumentaatiotasi ja leikkikenttää
|
|
4. Testaa API:t oikeilla tietomallillasi
|
|
|
|
Your documentation is unique to your workspace because it reflects your custom objects, fields, and relationships.
|
|
|
|
## Milloin käyttää kutakin APIa
|
|
|
|
### Käytä Metadata-API:ita kun:
|
|
|
|
- Setting up your data model
|
|
- Luot mukautettuja objekteja tai kenttiä
|
|
- Configuring workspace settings
|
|
|
|
### Käytä ydin-API:ita kun:
|
|
|
|
- Hallinnoit päivittäisiä tietoja (Ihmiset, Yritykset, Mahdollisuudet)
|
|
- Integrating with external systems
|
|
- Rakennat mukautettuja sovelluksia
|
|
- Automating data workflows
|
|
|
|
### Valitse GraphQL kun:
|
|
|
|
- Tarvitset erätoimintoja
|
|
- Haluat minimoida API-kutsut
|
|
- Tarvitset upsert-toimintoa
|
|
- Olet rakentamassa monimutkaisia integraatioita
|
|
|
|
### Valitse REST kun:
|
|
|
|
- Pidät yksinkertaisemmasta API-rakenteesta
|
|
- You're building basic integrations
|
|
- Your team is more familiar with REST
|
|
- Tarvitset suoraviivaisia CRUD-toimintoja
|
|
|
|
## Next Steps
|
|
|
|
- **[API & Webhooks-asetukset](/l/fi/user-guide/integrations-api/api-webhooks)**: Opi, kuinka luoda API-avaimia ja Webhooks
|
|
- **Custom Documentation**: Access your personalized API docs via Settings → API & Webhooks
|
|
|