feat: init
This commit is contained in:
@@ -0,0 +1,6 @@
|
||||
---
|
||||
description: Discover our wonderful API
|
||||
---
|
||||
|
||||
# 📖 API Reference
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
description: How to manage authentification on API call
|
||||
---
|
||||
|
||||
# Authentication
|
||||
|
||||
## Authencate your app in Twake
|
||||
|
||||
**All your connections** should respect the Basic access authentication protocol, which must be used via HTTPS, except in development mode. In order to make an API call with this method, you must add an HTTP header:
|
||||
|
||||
```text
|
||||
Authorization: Basic base64(public_id:private_api_key)
|
||||
```
|
||||
|
||||
**You must concatenate** your [public_id and private_api_key](../get-started/README.md#identity-and-api-settings) , **then convert** the whole **to base64**. Your HTTP header will therefore look like:
|
||||
|
||||
```text
|
||||
# For the keys 'public_id' and 'private_key'
|
||||
Authorization: Basic cHVibGljX2lkOnByaXZhdGVfYXBpX2tleQ==
|
||||
```
|
||||
|
||||
## Authencate your app in a company
|
||||
|
||||
**All your requests should have at least a "group_id" key with the company id you**
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
description: How to manage Drive through API
|
||||
---
|
||||
|
||||
# Drive
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
description: How to manage messages through API
|
||||
---
|
||||
|
||||
# Message
|
||||
|
||||
_While users have the ability to create message complexes using the built-in formatting system, applications can go even further and offer many types of messages such as system messages for notifications or interactive messages for your most popular applications._
|
||||
|
||||
## Group_id and channel_id:
|
||||
|
||||
1. Get the current front id:
|
||||
|
||||
`channel_service.currentChannelFrontId`
|
||||
|
||||
2. With the channel front id, you will be able to get the channel id by doing this:
|
||||
|
||||
`collections.collections.channels.manager.findByFrontId("My-Front-Id")`
|
||||
|
||||
3. Get the current group id:
|
||||
|
||||
`workspaceService.currentGroupId`
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
description: How to use webhook with Twake
|
||||
---
|
||||
|
||||
# Webhook
|
||||
|
||||
Reference in New Issue
Block a user