π
π
π
π
Shypyard Documentation
Searchβ¦
π
π
π
π
Shypyard Documentation
βWhat is Shypyard?
π
Need bespoke integration?
Resources
Getting started
Task library
Core concepts
Task triggers
Task code
Task runs
App
Platform services
Observability (logging)
Shypyard SDK
auths
Shypyard API
Email SMTP
Shopify
AWS
SFTP
Mongodb
API Clients
Integration to apps
List of supported integrations
Interacting with Shopify
Techniques
Limitations
Changelog
Privacy Policy
Powered By
GitBook
API Clients
For our API integrations, you will have access to our own API client to interact with the service APIs.
General way to acquire the api client is the following:
1
// const api = libs.<SERVICE_NAME>.get(<INTEGRATION_NAME>)
2
β
3
const api = libs.zendesk.get();
Copied!
Then you will make API calls with the following methods
1
api
.
request
({
2
path
:
...
,
3
method
:
...
,
4
data
:
...
,
5
headers
:
...
,
6
});
7
β
8
// or convenient functions
9
api
.
get
({
10
path
:
...
,
11
headers
:
...
,
12
});
13
β
14
api
.
post
({
15
path
:
...
,
16
data
:
...
,
17
headers
:
...
,
18
});
19
β
20
api
.
put
({
21
path
:
...
,
22
data
:
...
,
23
headers
:
...
,
24
});
25
β
26
api
.
delete
({
27
path
:
...
,
28
data
:
...
,
29
headers
:
...
,
30
});
Copied!
Previous
Mongodb
Next - Integration to apps
List of supported integrations
Last modified
1yr ago
Copy link