Skip to content

Commit

Permalink
feat(integrations):api support for teamtailor (NangoHQ#1747)
Browse files Browse the repository at this point in the history
## Describe your changes

- Added configuration for teamtailor in providers.yaml
- Added teamtailor to docs-v2.
- Added teamtailor pages for Supported API groups in mint.json.
- Added teamtailor SVG file in template-logos folder.
- Consolidate teamtailor docs pages

## Test
This provider has been used successfully in local development to connect
to Teamtailor and successfully call those endpoints after authorizing
using Nango.

The documentation update was reviewed using `npm run docs` and verifying
on localhost.

## Checklist before requesting a review (skip if just adding/editing
APIs & templates)
- [ ] I added tests, otherwise the reason is: 
- [ ] I added observability, otherwise the reason is:
- [ ] I added analytics, otherwise the reason is:
  • Loading branch information
hassan254-prog authored Mar 1, 2024
1 parent d6c955c commit 97a70bb
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs-v2/integrations/all/teamtailor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Teamtailor
sidebarTitle: Teamtailor
---

API configuration: [`teamtailor`](https://nango.dev/providers.yaml)

## Features

| Features | Status |
| - | - |
| [Auth (Basic)](/integrate/guides/authorize-an-api) ||
| [Sync data](/integrate/guides/sync-data-from-an-api) ||
| [Perform workflows](/integrate/guides/perform-workflows-with-an-api) ||
| [Proxy requests](/integrate/guides/proxy-requests-to-an-api) ||
| [Receive webhooks](/integrate/guides/receive-webhooks-from-an-api) | 🚫 (time to contribute: <48h) |

<Tip>We can implement missing features in &lt;48h, just ask for it in the [community](https://nango.dev/slack).</Tip>

## Getting started

- [Generate an API key in your Teamtailor account](https://app.teamtailor.com/app/settings/integrations/api_keys)
- [Teamtailor API docs](https://docs.teamtailor.com)
- [Authentication and API key scopes](https://docs.teamtailor.com/#authentication)
- [API rate limits](https://docs.teamtailor.com/#rate-limit)
- [API versioning](https://docs.teamtailor.com/#versioning)

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

## API gotchas

- Teamtailor uses API_KEY auth mode with Authorization: Token token=`api_key` in the request header to access different endpoints.
- The rate limit allows for a maximum of 50 requests per 10 seconds.
- All API calls must have `X-Api-Version` as a header to resolve API versions.
- Teamtailor uses different domain extensions for different regions, i.e `na` for US West(Oregon) Hosted Customers. For EU(Ireland) based clients, add `api` as your extension but for US West(Oregon) based customers add `api.na` as your extension.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/teamtailor.mdx)</Note>
1 change: 1 addition & 0 deletions docs-v2/integrations/ats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ sidebarTitle: ATS
<Card title="Lever" href="/integrations/all/lever" color="#68a063" />
<Card title="LinkedIn" href="/integrations/all/linkedin" color="#68a063" />
<Card title="SmartRecruiters" href="/integrations/all/smartrecruiters" color="#68a063" />
<Card title="Teamtailor" href="/integrations/all/teamtailor" color="#68a063" />
<Card title="Workable" href="/integrations/all/workable" color="#68a063" />
</CardGroup>
1 change: 1 addition & 0 deletions docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@
"integrations/all/stripe-app",
"integrations/all/stripe-express",
"integrations/all/survey-monkey",
"integrations/all/teamtailor",
"integrations/all/teamwork",
"integrations/all/tiktok-accounts",
"integrations/all/tiktok-ads",
Expand Down
12 changes: 12 additions & 0 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1842,6 +1842,18 @@ survey-monkey:
proxy:
base_url: https://api.surveymonkey.com
docs: https://docs.nango.dev/integrations/all/survey-monkey
teamtailor:
categories:
- ats
auth_mode: API_KEY
proxy:
base_url: https://{connectionConfig.extension}.teamtailor.com
retry:
after: 'X-Rate-Limit-Reset'
headers:
Authorization: Token token=${apiKey}
X-Api-Version: '20210218'
docs: https://docs.nango.dev/integrations/all/teamtailor
teamwork:
categories:
- productivity
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97a70bb

Please sign in to comment.