Skip to content

Commit e3e0d29

Browse files
PegasuzPegasuz
committed
Use new focus domainnames
1 parent 6f0bc55 commit e3e0d29

File tree

10 files changed

+51
-51
lines changed

10 files changed

+51
-51
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains the Teamleader API Definition in [API Blueprint](https:
44

55
## Published documentation
66

7-
Our latest API definition is automatically published on [developer.teamleader.eu](https://developer.teamleader.eu).
7+
Our latest API definition is automatically published on [developer.focus.teamleader.eu](https://developer.focus.teamleader.eu).
88

99
## Contributing
1010

‎apiary.apib

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
FORMAT: 1A
2-
HOST: https://api.teamleader.eu
2+
HOST: https://api.focus.teamleader.eu
33

44
# Teamleader API
55

@@ -11,13 +11,13 @@ Do you have any feedback, do you miss functionality to support your use case? Le
1111

1212
An API is an Application Programming Interface. It is used to programmatically interact with Teamleader, integrate with other software tools or add custom functionalities to Teamleader.
1313

14-
Before creating a new integration, make sure to check our existing integrations built by our community in our [Teamleader Marketplace](https://marketplace.teamleader.eu).
14+
Before creating a new integration, make sure to check our existing integrations built by our community in our [Teamleader Marketplace](https://marketplace.focus.teamleader.eu).
1515

1616
## General principles
1717

1818
### Endpoints
1919

20-
Our API consists of HTTP RPC-style methods, in the form of `https://api.teamleader.eu/resource.action`.
20+
Our API consists of HTTP RPC-style methods, in the form of `https://api.focus.teamleader.eu/resource.action`.
2121

2222
We chose this action based approach over the more popular REST, because it enables us to have domain related actions on resources such as `invoices.book`, `timetracking.start` and `timetracking.stop`.
2323

@@ -28,7 +28,7 @@ All methods must be called using HTTPS. Data is passed as JSON data in a POST re
2828
For more complex actions we recommend using POST requests with JSON:
2929

3030
```
31-
POST https://api.teamleader.eu/invoices.list
31+
POST https://api.focus.teamleader.eu/invoices.list
3232
3333
{
3434
"filter": {
@@ -44,7 +44,7 @@ POST https://api.teamleader.eu/invoices.list
4444
The GET equivalent:
4545

4646
```
47-
GET https://api.teamleader.eu/invoices.list?filter[department_id]=9d4096c3-813f-4bd5-b3c4-4091807b5b74&page[number]=3&page[size]=50&company_id=3250c613-c478-4a43-9640-b97da923eb21
47+
GET https://api.focus.teamleader.eu/invoices.list?filter[department_id]=9d4096c3-813f-4bd5-b3c4-4091807b5b74&page[number]=3&page[size]=50&company_id=3250c613-c478-4a43-9640-b97da923eb21
4848
```
4949

5050
### Responses
@@ -149,17 +149,17 @@ OAuth 2 is an authorization framework that allows a user to grant limited access
149149

150150
To get access to the protected resources using our API, OAuth 2 uses access tokens. An access token is a string representing the granted permissions. Access tokens can be obtained after a user has completed the OAuth 2 authorization flow.
151151

152-
Before starting, you will need to register your integration (an OAuth 2 client) on our [Marketplace](https://marketplace.teamleader.eu/build). Each registered integration is assigned a unique `client_id` and `client_secret`, which is used in the OAuth 2 authorization flow. Note that the `client_secret` key should not be shared or embedded in client-side code.
152+
Before starting, you will need to register your integration (an OAuth 2 client) on our [Marketplace](https://marketplace.focus.teamleader.eu/build). Each registered integration is assigned a unique `client_id` and `client_secret`, which is used in the OAuth 2 authorization flow. Note that the `client_secret` key should not be shared or embedded in client-side code.
153153

154-
When you register an integration on our [Marketplace](https://marketplace.teamleader.eu), it is required to select all *scopes* your integration wants access to.
154+
When you register an integration on our [Marketplace](https://marketplace.focus.teamleader.eu), it is required to select all *scopes* your integration wants access to.
155155

156156
For more detailed information about OAuth 2, we recommend reading [this article](https://auth0.com/docs/protocols/oauth2).
157157

158158
### Authorization flow
159159

160160
To get access to a user's Teamleader data using the *authorization code grant type*, redirect users to the Teamleader authorization page:
161161

162-
`https://app.teamleader.eu/oauth2/authorize`
162+
`https://focus.teamleader.eu/oauth2/authorize`
163163

164164
The required GET parameters are:
165165

@@ -168,9 +168,9 @@ The required GET parameters are:
168168
- `state` - unique string to be passed back upon completion (optional)
169169
- `redirect_uri` - URL to redirect back to after authorization
170170

171-
> A list of allowed redirect URIs needs to be configured on your integration's [settings page](https://marketplace.teamleader.eu/build). Only redirect URIs matching one of these whitelisted URIs will be accepted. This is a security measure to prevent malicious users to impersonate your integration.
171+
> A list of allowed redirect URIs needs to be configured on your integration's [settings page](https://marketplace.focus.teamleader.eu/build). Only redirect URIs matching one of these whitelisted URIs will be accepted. This is a security measure to prevent malicious users to impersonate your integration.
172172
173-
After logging in, the user will be asked to authorize your integration to access the data in their account. You will only be granted access to certain Teamleader data, based on the scopes you have selected on your integration's [settings page](https://marketplace.teamleader.eu/build).
173+
After logging in, the user will be asked to authorize your integration to access the data in their account. You will only be granted access to certain Teamleader data, based on the scopes you have selected on your integration's [settings page](https://marketplace.focus.teamleader.eu/build).
174174

175175
If the user authorizes your integration, they will be redirected to the specified `redirect_uri` with a temporary authorization code and the original `state` parameter. If the `state` parameter does not match the original value, the response may have been created by a third party and should be ignored.
176176

@@ -184,7 +184,7 @@ If the user denies your integration, he will be redirected to the `redirect_uri`
184184

185185
After receiving the authorization code from the previous step, an access token can be requested to make API calls. Note that authorization codes can only be exchanged for an access token once and expire 10 minutes after issuance. To exchange the code for an access token, send an HTTP POST request to the following endpoint:
186186

187-
`https://app.teamleader.eu/oauth2/access_token`
187+
`https://focus.teamleader.eu/oauth2/access_token`
188188

189189
The required POST parameters are:
190190

@@ -213,7 +213,7 @@ You will receive a JSON response containing an `access_token` and `refresh_token
213213
These access tokens are also known as bearer tokens. You can use this token to call API endpoints on behalf of the user, by adding it to the API request as an `Authorization` header.
214214

215215
```
216-
GET https://api.teamleader.eu/contacts.list HTTP/1.1
216+
GET https://api.focus.teamleader.eu/contacts.list HTTP/1.1
217217
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciO...
218218
Accept: application/json
219219
```
@@ -224,7 +224,7 @@ Access tokens expire shortly (usually 1 hour) after they are issued for security
224224

225225
If an access token is expired, a new access token and refresh token pair can be obtained by sending an HTTP POST request to the following endpoint:
226226

227-
`https://app.teamleader.eu/oauth2/access_token`
227+
`https://focus.teamleader.eu/oauth2/access_token`
228228

229229
The required POST parameters are:
230230

@@ -242,7 +242,7 @@ The implicit grant is a simplified authorization code flow optimized for clients
242242

243243
Similar to the regular flow, users are redirected to the Teamleader authorization page, but use `token` as the `response_type`:
244244

245-
`https://app.teamleader.eu/oauth2/authorize`
245+
`https://focus.teamleader.eu/oauth2/authorize`
246246

247247
The required GET parameters are:
248248

@@ -251,7 +251,7 @@ The required GET parameters are:
251251
- `state` - unique string to be passed back upon completion (optional)
252252
- `redirect_uri` - URL to redirect back to after authorization
253253

254-
> A list of allowed redirect URIs needs to be configured on your integration's [settings page](https://marketplace.teamleader.eu/build). Only redirect URIs matching one of these whitelisted URIs will be accepted. This is a security measure to prevent malicious users to impersonate your integration.
254+
> A list of allowed redirect URIs needs to be configured on your integration's [settings page](https://marketplace.focus.teamleader.eu/build). Only redirect URIs matching one of these whitelisted URIs will be accepted. This is a security measure to prevent malicious users to impersonate your integration.
255255
256256
After authorization, the user is redirected to the `redirect_uri` with the following parameters in the **fragment part of the url**:
257257

@@ -270,7 +270,7 @@ Note that the implicit grant does not return refresh tokens and that our access
270270

271271
To retrieve information about the user who authorized your application (the resource owner), call the `users.me` API endpoint:
272272

273-
`https://api.teamleader.eu/users.me`
273+
`https://api.focus.teamleader.eu/users.me`
274274

275275
### PHP code example
276276

@@ -1165,7 +1165,7 @@ Get a list of contacts.
11651165
+ tags: prospect, expo (array[string])
11661166
+ added_at: `2016-02-04T16:44:33+00:00` (string)
11671167
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
1168-
+ `web_url`: `https://app.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f` (string)
1168+
+ `web_url`: `https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f` (string)
11691169

11701170
### contacts.info [GET /contacts.info]
11711171

@@ -1227,7 +1227,7 @@ Get details for a single contact.
12271227
+ marketing_mails_consent: false (boolean)
12281228
+ added_at: `2016-02-04T16:44:33+00:00` (string)
12291229
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
1230-
+ `web_url`: `https://app.teamleader.eu/contact_detail.php?id=cde0bc5f-8602-4e12-b5d3-f03436b54c0d` (string)
1230+
+ `web_url`: `https://focus.teamleader.eu/contact_detail.php?id=cde0bc5f-8602-4e12-b5d3-f03436b54c0d` (string)
12311231

12321232
### contacts.add [POST /contacts.add]
12331233

@@ -1456,7 +1456,7 @@ Get a list of companies.
14561456
+ id: `9b99d8f8-183b-4c7b-8354-9b98b47a192e` (string)
14571457
+ added_at: `2016-02-04T16:44:33+00:00` (string)
14581458
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
1459-
+ `web_url`: `https://app.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e` (string)
1459+
+ `web_url`: `https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e` (string)
14601460
+ tags: prospect, expo (array[string])
14611461

14621462
### companies.info [GET /companies.info]
@@ -1510,7 +1510,7 @@ Get details for a single company.
15101510
+ remarks: `First contact at expo` (string) - Uses Markdown formatting
15111511
+ added_at: `2016-02-04T16:44:33+00:00` (string)
15121512
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
1513-
+ `web_url`: `https://app.teamleader.eu/company_detail.php?id=e8d31ae7-8258-4fcd-9b2d-78f41b0aa5d5` (string)
1513+
+ `web_url`: `https://focus.teamleader.eu/company_detail.php?id=e8d31ae7-8258-4fcd-9b2d-78f41b0aa5d5` (string)
15141514
+ tags: prospect, expo (array[string])
15151515
+ custom_fields (array[CustomField])
15161516
+ marketing_mails_consent: false (boolean)
@@ -1813,7 +1813,7 @@ Get a list of deals.
18131813
+ remark: `Too expensive` (string, nullable)
18141814
+ created_at: `2017-05-09T11:25:11+00:00` (string)
18151815
+ updated_at: `2017-05-09T11:30:58+00:00` (string)
1816-
+ `web_url`: `https://app.teamleader.eu/sale_detail.php?id=6e7fe84d-d4b3-4723-abae-9bc082d8f65a` (string)
1816+
+ `web_url`: `https://focus.teamleader.eu/sale_detail.php?id=6e7fe84d-d4b3-4723-abae-9bc082d8f65a` (string)
18171817

18181818
### deals.info [GET /deals.info]
18191819

@@ -1885,7 +1885,7 @@ Get details for a single deal.
18851885
+ remark: `Too expensive` (string, nullable)
18861886
+ created_at: `2017-05-09T11:25:11+00:00` (string)
18871887
+ updated_at: `2017-05-09T11:30:58+00:00` (string)
1888-
+ `web_url`: `https://app.teamleader.eu/sale_detail.php?id=f6871b06-6513-4750-b5e6-ff3503b5a029` (string)
1888+
+ `web_url`: `https://focus.teamleader.eu/sale_detail.php?id=f6871b06-6513-4750-b5e6-ff3503b5a029` (string)
18891889
+ custom_fields (array[CustomField])
18901890

18911891
### deals.create [POST /deals.create]
@@ -2637,7 +2637,7 @@ Get a list of invoices.
26372637
+ rate: 1.1234 (number)
26382638
+ created_at: `2016-02-04T16:44:33+00:00` (string)
26392639
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
2640-
+ `web_url`: `https://app.teamleader.eu/invoice_detail.php?id=2aa4a6a9-9ce8-4851-a9b3-26aea2ea14c4` (string)
2640+
+ `web_url`: `https://focus.teamleader.eu/invoice_detail.php?id=2aa4a6a9-9ce8-4851-a9b3-26aea2ea14c4` (string)
26412641
+ file (object, nullable)
26422642
+ type: `file` (string)
26432643
+ id: `39a02b79-b9a9-46e3-a44d-6c473b2fe350` (string)

‎examples/oauth2.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
/**
44
* Replace the values below with your integration's information found on the marketplace build page.
5-
* https://marketplace.teamleader.eu/eu/en/build/integrations
5+
* https://marketplace.focus.teamleader.eu/eu/en/build/integrations
66
*/
77
$clientId = 'YOUR-CLIENT-ID';
88
$clientSecret = 'YOUR-CLIENT-SECRET';
@@ -28,7 +28,7 @@
2828
* Request an access token based on the received authorization code.
2929
*/
3030
$ch = curl_init();
31-
curl_setopt($ch, CURLOPT_URL, 'https://app.teamleader.eu/oauth2/access_token');
31+
curl_setopt($ch, CURLOPT_URL, 'https://focus.teamleader.eu/oauth2/access_token');
3232
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
3333
curl_setopt($ch, CURLOPT_POST, true);
3434
curl_setopt($ch, CURLOPT_POSTFIELDS, [
@@ -47,7 +47,7 @@
4747
* Get the user identity information using the access token.
4848
*/
4949
$ch = curl_init();
50-
curl_setopt($ch, CURLOPT_URL, 'https://api.teamleader.eu/users.me');
50+
curl_setopt($ch, CURLOPT_URL, 'https://api.focus.teamleader.eu/users.me');
5151
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
5252
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $accessToken]);
5353

@@ -64,6 +64,6 @@
6464
'redirect_uri' => $redirectUri,
6565
];
6666

67-
header('Location: https://app.teamleader.eu/oauth2/authorize?' . http_build_query($query));
67+
header('Location: https://focus.teamleader.eu/oauth2/authorize?' . http_build_query($query));
6868

6969
}

‎src/02-crm/companies.apib

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Get a list of companies.
7272
+ id: `9b99d8f8-183b-4c7b-8354-9b98b47a192e` (string)
7373
+ added_at: `2016-02-04T16:44:33+00:00` (string)
7474
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
75-
+ `web_url`: `https://app.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e` (string)
75+
+ `web_url`: `https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e` (string)
7676
+ tags: prospect, expo (array[string])
7777

7878
### companies.info [GET /companies.info]
@@ -126,7 +126,7 @@ Get details for a single company.
126126
+ remarks: `First contact at expo` (string) - Uses Markdown formatting
127127
+ added_at: `2016-02-04T16:44:33+00:00` (string)
128128
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
129-
+ `web_url`: `https://app.teamleader.eu/company_detail.php?id=e8d31ae7-8258-4fcd-9b2d-78f41b0aa5d5` (string)
129+
+ `web_url`: `https://focus.teamleader.eu/company_detail.php?id=e8d31ae7-8258-4fcd-9b2d-78f41b0aa5d5` (string)
130130
+ tags: prospect, expo (array[string])
131131
+ custom_fields (array[CustomField])
132132
+ marketing_mails_consent: false (boolean)

‎src/02-crm/contacts.apib

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Get a list of contacts.
7272
+ tags: prospect, expo (array[string])
7373
+ added_at: `2016-02-04T16:44:33+00:00` (string)
7474
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
75-
+ `web_url`: `https://app.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f` (string)
75+
+ `web_url`: `https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f` (string)
7676

7777
### contacts.info [GET /contacts.info]
7878

@@ -134,7 +134,7 @@ Get details for a single contact.
134134
+ marketing_mails_consent: false (boolean)
135135
+ added_at: `2016-02-04T16:44:33+00:00` (string)
136136
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
137-
+ `web_url`: `https://app.teamleader.eu/contact_detail.php?id=cde0bc5f-8602-4e12-b5d3-f03436b54c0d` (string)
137+
+ `web_url`: `https://focus.teamleader.eu/contact_detail.php?id=cde0bc5f-8602-4e12-b5d3-f03436b54c0d` (string)
138138

139139
### contacts.add [POST /contacts.add]
140140

‎src/03-deals/deals.apib

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Get a list of deals.
9797
+ remark: `Too expensive` (string, nullable)
9898
+ created_at: `2017-05-09T11:25:11+00:00` (string)
9999
+ updated_at: `2017-05-09T11:30:58+00:00` (string)
100-
+ `web_url`: `https://app.teamleader.eu/sale_detail.php?id=6e7fe84d-d4b3-4723-abae-9bc082d8f65a` (string)
100+
+ `web_url`: `https://focus.teamleader.eu/sale_detail.php?id=6e7fe84d-d4b3-4723-abae-9bc082d8f65a` (string)
101101

102102
### deals.info [GET /deals.info]
103103

@@ -169,7 +169,7 @@ Get details for a single deal.
169169
+ remark: `Too expensive` (string, nullable)
170170
+ created_at: `2017-05-09T11:25:11+00:00` (string)
171171
+ updated_at: `2017-05-09T11:30:58+00:00` (string)
172-
+ `web_url`: `https://app.teamleader.eu/sale_detail.php?id=f6871b06-6513-4750-b5e6-ff3503b5a029` (string)
172+
+ `web_url`: `https://focus.teamleader.eu/sale_detail.php?id=f6871b06-6513-4750-b5e6-ff3503b5a029` (string)
173173
+ custom_fields (array[CustomField])
174174

175175
### deals.create [POST /deals.create]

‎src/05-invoicing/invoices.apib

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Get a list of invoices.
8787
+ rate: 1.1234 (number)
8888
+ created_at: `2016-02-04T16:44:33+00:00` (string)
8989
+ updated_at: `2016-02-05T16:44:33+00:00` (string)
90-
+ `web_url`: `https://app.teamleader.eu/invoice_detail.php?id=2aa4a6a9-9ce8-4851-a9b3-26aea2ea14c4` (string)
90+
+ `web_url`: `https://focus.teamleader.eu/invoice_detail.php?id=2aa4a6a9-9ce8-4851-a9b3-26aea2ea14c4` (string)
9191
+ file (object, nullable)
9292
+ type: `file` (string)
9393
+ id: `39a02b79-b9a9-46e3-a44d-6c473b2fe350` (string)

‎src/apiary.apib

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
FORMAT: 1A
2-
HOST: https://api.teamleader.eu
2+
HOST: https://api.focus.teamleader.eu
33

44
# Teamleader API
55

0 commit comments

Comments
 (0)