admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

2915 rest api documentation (#3020)

Browse Source 
* Init rest-api page

* Add ugly form to fetch open api schema

* Clean code

* Make the form design more acceptable

* Update doc

* Use local storage

* Update design

* Add isLoading

* Fix typo

* Fix long lines

* Code review returns

* Remove staging and local url from servers
This commit is contained in:
martmull
2023-12-15 18:13:13 +01:00
committed by GitHub
parent 9f6d476351
commit 3ac4102c3c
10 changed files with 2474 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
packages/twenty-docs/docs/developer/rest_api.mdx
View File

@ -1,9 +1,30 @@
---
title: Rest API
title: REST API
sidebar_position: 3
sidebar_class_name: coming-soon
sidebar_custom_props:
icon: TbApi
---
Coming soon!
To use the REST API, you will need an API key.
Connect to your Twenty account and follow the following
[documentation](user-guide/integrations/generating-api-keys.mdx) to generate one
## Using Postman?
You can use [Postman](https://www.postman.com/) to interact with your Twenty objects using the API.
You will need to provide your API key as a Bearer token,
see [Bearer Token Postman Doc](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token)
if needed.
## Programmatic use?
You can call the REST API in your application using this endpoint
[https://api.twenty.com](https://api.twenty.com).
You will need to provide your API key as a Bearer token in
your `headers.Authorization = 'Bearer <YOUR_API_KEY>'`.
## Try the REST API Playground
You can use the browser-based, interactive
[REST API playground documentation](https://docs.twenty.com/rest-api)
to Create, Read, Update or Delete your workspace objects.

4
packages/twenty-docs/docs/user-guide/integrations/connect-zapier.mdx
View File

@ -17,11 +17,11 @@ Sync Twenty with 3000+ apps using [Zapier](https://zapier.com/), and automate yo
2. Click on `+ Create Zap` in the left sidebar.
3. Choose the application you want to set as the trigger. A trigger refers to an event that starts the automation.
4. Select Twenty as the action. An action is the event performed whenever an application triggers an automation. [Learn more about triggers and actions in Zapier.](https://zapier.com/how-it-works)
5. Once you choose the Twenty account that you want to use for your automation, you'll have to authorize it by adding an API key. You can learn [how to generate your API key here.](generating-api-keys.mdx)
5. Once you choose the Twenty account that you want to use for your automation, you'll have to authorize it by adding an API key. You can learn [how to generate your API key here.](user-guide/integrations/generating-api-keys.mdx)
6. Enter your API key and click on 'Yes, Continue to Twenty.'
<div style={{textAlign: 'center'}}>
<img src="/img/user-guide/connect-zapier.png" alt="Connect Twenty to Zapier" />
</div>
You can now continue creating your automation!
You can now continue creating your automation!