From 79db824fd78a00ae30f5e533c503850fd217579c Mon Sep 17 00:00:00 2001 From: Conor Teichroeb Date: Fri, 16 Oct 2026 12:46:31 -0700 Subject: [PATCH] Remove deprecated /v3/ua/login, fix stale references to /oauth/token POST /api/v3/ua/login is deprecated. Removed its "### Login" section and sidebar entry from guidelines/user-api.mdx entirely. Across 13 quickstart guides and tutorials, each "Log in" step's header and curl/JSON examples already correctly showed /ua/oauth/token, but left two kinds of artifacts from before that switch: - Top-of-page endpoint summary lists still linking to /ua/login (contextual-audience-quickstart, create-a-campaign-quickstart, conversion-quickstart, bid-model-quickstart). - A stale TypeScript "Login" tab in every file's "Log in" step, still posting JSON to /ua/login with grantType/email fields - left over from before the endpoint became form-urlencoded oauth/token. Removed these (matching the established convention for oauth/token calls: no TypeScript tab anywhere else, including authentication-quickstart- guide.mdx's own "Refresh token" section and user-api.mdx's "OAuth token" section, since representing a form-urlencoded request as a JSON axios call would be wrong either way) and replaced the accompanying JSON request example with the same curl pattern already used elsewhere, fixing the field names along the way (grantType -> grant_type, email -> username, matching the real form param names). Also fixed the same grantType/email artifacts in authentication-quickstart-guide.mdx's own Log in and Refresh token request schema tables, which had survived independently of the stale TS tab. Co-Authored-By: Claude Sonnet 5 --- docs/guidelines/user-api.mdx | 193 ------------------ .../authentication-quickstart-guide.mdx | 81 +------- .../bid-model-quickstart.mdx | 2 +- .../contextual-audience-quickstart.mdx | 97 ++------- .../conversion-quickstart.mdx | 94 +-------- .../create-a-campaign-quickstart.mdx | 97 ++------- .../quickstart-guides/insights-quickstart.mdx | 92 +-------- .../inventory-quickstart.mdx | 92 +-------- ...d-audience-upload-api-quickstart-guide.mdx | 92 +-------- .../reporting-api-quickstart-guide.mdx | 92 +-------- .../schedule-report-api-quickstart-guide.mdx | 92 +-------- .../upload-a-creative-quickstart.mdx | 92 +-------- ...create-a-campaign-api-quickstart-guide.mdx | 92 +-------- docs/tutorials/customer-guide.mdx | 92 +-------- docs/tutorials/deal-guide.mdx | 92 +-------- sidebars.js | 7 - 16 files changed, 131 insertions(+), 1268 deletions(-) diff --git a/docs/guidelines/user-api.mdx b/docs/guidelines/user-api.mdx index c37a1bc1b..deec3b3b7 100644 --- a/docs/guidelines/user-api.mdx +++ b/docs/guidelines/user-api.mdx @@ -31,199 +31,6 @@ Use the following header parameters for all requests: ## Authentication -### Login - - - -
-
- -Log in to the IQM platform with your email and password, and grant type set to password. - -| Request schema | | -| ---- | --- | -| `grantType`
string | [OAuth Grant Types](https://oauth.net/2/grant-types/). | -| `email`
string | User's email. | -| `password`
string | User's password. | - -
-Response properties - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
`success`
boolean		Indicates user successfully logged in: true.
`access_token`
string		Access token.
`refresh_token`
string		Refresh token.
`scope`
string		User access rights.
`token_type`
string		Token type.
`expires_in`
integer		Time until token expires.
`owId`
integer		Organization Workspace ID.
-
- -
- - - - -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} -``` - -```json title="Response 200" -{ - "success": true, - "data": { - "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", - "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", - "scope": "read write", - "token_type": "bearer", - "expires_in": 35999, - "owId": 200001 - } -} -``` - -
-More responses - -```json title="Response 400" -{ - "success": false, - "data": { - "status": "On Hold", - "reason": "The particular account is kept on hold due to missed payment dates for last 3 months.", - "supportEmail": "support@iqm.com" - }, - "errorObjects": [ - { - "error": "User is not allowed to access provided customer", - "reason": "User is not associated with any active organization." - } - ] -} -``` - -```json title="Response 403" -{ - "success": false, - "errorObjects": [ - { - "error": "User doesn't exist or user is not allowed to provided workspace." - } - ] -} -``` - -
- - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - - expires_in: number; - - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - grantType: `string`, - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` - - - -
- ---- - ### OAuth token diff --git a/docs/quickstart-guides/authentication-quickstart-guide.mdx b/docs/quickstart-guides/authentication-quickstart-guide.mdx index 7160aee3b..e6a5dbd61 100644 --- a/docs/quickstart-guides/authentication-quickstart-guide.mdx +++ b/docs/quickstart-guides/authentication-quickstart-guide.mdx @@ -155,8 +155,8 @@ The response includes an access token, refresh token, and the Organization Works | Request Schema | | | ---- | --- | -| `grantType`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -188,81 +188,6 @@ curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ } ``` - - - -See [TypeScript Prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - grantType: `string`, - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
@@ -283,7 +208,7 @@ Use a refresh token to get a new access token. This endpoint accepts a URL encod | Request Schema | | | --- | --- | -| `grantType`
string | refresh_token to get a new access token
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `grant_type`
string | refresh_token to get a new access token
[OAuth Grant Types](https://oauth.net/2/grant-types/) | | `refresh_token`
string | Refresh token | diff --git a/docs/quickstart-guides/bid-model-quickstart.mdx b/docs/quickstart-guides/bid-model-quickstart.mdx index 85c24039e..14c28a9c2 100644 --- a/docs/quickstart-guides/bid-model-quickstart.mdx +++ b/docs/quickstart-guides/bid-model-quickstart.mdx @@ -16,7 +16,7 @@ Create a Bid Model with this in-depth tutorial using IQM's API. The following endpoints are used to check a campaign's eligibility and create a Bid Model: - +


diff --git a/docs/quickstart-guides/contextual-audience-quickstart.mdx b/docs/quickstart-guides/contextual-audience-quickstart.mdx index 8ea471b2a..89813dcb8 100644 --- a/docs/quickstart-guides/contextual-audience-quickstart.mdx +++ b/docs/quickstart-guides/contextual-audience-quickstart.mdx @@ -15,7 +15,7 @@ Create your first audience using IQM's API in this step-by-step quickstart guide The following endpoints are used to create a Contextual audience: - +

@@ -78,13 +78,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Headers | | | ---- | --- | -| `Authentication`
string required | Authentication bearer token. See [Sign up and authenticate](/quickstart-guides/authentication-quickstart-guide) | +| `Authentication`
string required | Client ID and Client Secret | +| `Content-Type`
string required | application/x-www-form-urlencoded | | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -92,12 +93,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request schema" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -150,80 +153,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). ``` - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/conversion-quickstart.mdx b/docs/quickstart-guides/conversion-quickstart.mdx index cf82f7893..a161f6af7 100644 --- a/docs/quickstart-guides/conversion-quickstart.mdx +++ b/docs/quickstart-guides/conversion-quickstart.mdx @@ -18,7 +18,7 @@ Create a conversion with this in-depth tutorial using IQM's API. The following endpoints are used to create a conversion and assign it to a campaign: - +

@@ -85,8 +85,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ----| --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -94,12 +94,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -153,80 +155,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/create-a-campaign-quickstart.mdx b/docs/quickstart-guides/create-a-campaign-quickstart.mdx index 37a3b405a..74ae69d43 100644 --- a/docs/quickstart-guides/create-a-campaign-quickstart.mdx +++ b/docs/quickstart-guides/create-a-campaign-quickstart.mdx @@ -19,7 +19,7 @@ Create your first campaign using IQM's API in this step-by-step quickstart guide The following endpoints are used to create an insertion order (IO) and start a campaign: - +


@@ -80,13 +80,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Headers | | | ---- | --- | -| `Authentication`
string required | Authentication bearer token. See [Sign up and authenticate](/quickstart-guides/authentication-quickstart-guide) | +| `Authentication`
string required | Client ID and Client Secret | +| `Content-Type`
string required | application/x-www-form-urlencoded | | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -94,12 +95,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request schema" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -152,80 +155,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). ``` - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/insights-quickstart.mdx b/docs/quickstart-guides/insights-quickstart.mdx index 8e6994ff1..388a4e614 100644 --- a/docs/quickstart-guides/insights-quickstart.mdx +++ b/docs/quickstart-guides/insights-quickstart.mdx @@ -65,8 +65,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -74,12 +74,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request schema" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -133,80 +135,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/inventory-quickstart.mdx b/docs/quickstart-guides/inventory-quickstart.mdx index aad58bf76..367a3cbe9 100644 --- a/docs/quickstart-guides/inventory-quickstart.mdx +++ b/docs/quickstart-guides/inventory-quickstart.mdx @@ -86,8 +86,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ----| --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -95,12 +95,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -154,80 +156,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/matched-audience-upload-api-quickstart-guide.mdx b/docs/quickstart-guides/matched-audience-upload-api-quickstart-guide.mdx index c8b06386e..3cfe01dfd 100644 --- a/docs/quickstart-guides/matched-audience-upload-api-quickstart-guide.mdx +++ b/docs/quickstart-guides/matched-audience-upload-api-quickstart-guide.mdx @@ -103,8 +103,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required| User account password |
@@ -112,12 +112,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -171,80 +173,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/reporting-api-quickstart-guide.mdx b/docs/quickstart-guides/reporting-api-quickstart-guide.mdx index 53ce501ca..ff8bb4ac3 100644 --- a/docs/quickstart-guides/reporting-api-quickstart-guide.mdx +++ b/docs/quickstart-guides/reporting-api-quickstart-guide.mdx @@ -79,8 +79,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ----| --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -88,12 +88,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -147,80 +149,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/schedule-report-api-quickstart-guide.mdx b/docs/quickstart-guides/schedule-report-api-quickstart-guide.mdx index 033518cbf..f9c3d9b93 100644 --- a/docs/quickstart-guides/schedule-report-api-quickstart-guide.mdx +++ b/docs/quickstart-guides/schedule-report-api-quickstart-guide.mdx @@ -71,8 +71,8 @@ To log in, the Authentication: Basic header is required. The Login AP | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -80,12 +80,14 @@ To log in, the Authentication: Basic header is required. The Login AP -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -139,80 +141,6 @@ To log in, the Authentication: Basic header is required. The Login AP - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/upload-a-creative-quickstart.mdx b/docs/quickstart-guides/upload-a-creative-quickstart.mdx index 542791ecf..60f2f89fc 100644 --- a/docs/quickstart-guides/upload-a-creative-quickstart.mdx +++ b/docs/quickstart-guides/upload-a-creative-quickstart.mdx @@ -97,8 +97,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -106,12 +106,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -166,80 +168,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). ``` - - - -See [TypeScript Prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/quickstart-guides/upload-creative-and-create-a-campaign-api-quickstart-guide.mdx b/docs/quickstart-guides/upload-creative-and-create-a-campaign-api-quickstart-guide.mdx index c6d4e9055..b4340e9a9 100644 --- a/docs/quickstart-guides/upload-creative-and-create-a-campaign-api-quickstart-guide.mdx +++ b/docs/quickstart-guides/upload-creative-and-create-a-campaign-api-quickstart-guide.mdx @@ -90,8 +90,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required | User account password |
@@ -99,12 +99,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -157,80 +159,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). ``` - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/tutorials/customer-guide.mdx b/docs/tutorials/customer-guide.mdx index e5e1776da..110a25e28 100644 --- a/docs/tutorials/customer-guide.mdx +++ b/docs/tutorials/customer-guide.mdx @@ -57,8 +57,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required| User account password |
@@ -66,12 +66,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -125,80 +127,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/docs/tutorials/deal-guide.mdx b/docs/tutorials/deal-guide.mdx index 131ccf444..6b82e7cf0 100644 --- a/docs/tutorials/deal-guide.mdx +++ b/docs/tutorials/deal-guide.mdx @@ -54,8 +54,8 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). | Request schema | | | ---- | --- | -| `grantType`
string required | [OAuth Grant Types](https://oauth.net/2/grant-types/) | -| `email`
string required | User account email | +| `grant_type`
string required | password for login
[OAuth Grant Types](https://oauth.net/2/grant-types/) | +| `username`
string required | User account email | | `password`
string required| User account password |
@@ -63,12 +63,14 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). -```json title="Request sample" -{ - "grantType": "password", - "email": "pratik.t+ihp@iqm.com", - "password": "123456" -} +```curl title="Request sample" +curl -i --location 'https://api.iqm.com/api/v3/ua/oauth/token' \ +--header 'accept: application/json, text/plain, */*' \ +--header 'Authorization: Basic ' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grant_type=password' \ +--data-urlencode 'username=user@iqm.com' \ +--data-urlencode 'password=' ``` ```json title="Response 200" @@ -122,80 +124,6 @@ For further information see [OAuth token](/guidelines/user-api#oauth-token). - - - -See [TypeScript prerequisites](/getting-started/typescript-prerequisites.mdx) page for usage. - -```ts -import { - getInstance -} from "prerequisites" - -const axios = getInstance(); - -interface Responses { - 200: { - content: { - "application/json": { - success: boolean; - data: { - access_token: string; - refresh_token: string; - scope: string; - token_type: string; - expires_in: number; - owId: number; - }; - }; - }; - }; - 400: { - content: { - "application/json": { - success: boolean; - data: { - status: string; - reason: string; - supportEmail: string; - }; - errorObjects: { - error: string; - reason: string; - }[]; - }; - }; - }; - 403: { - content: { - "application/json": { - success: boolean; - errorObjects: { - error: string; - }[]; - }; - }; - }; -}; - -function Login(): Promise < Responses > { - const options = { - method: 'POST', - url: 'https://api.iqm.com/api/v3/ua/login', - requestBody: { - content: { - "application/json": { - email: `string`, - password: `string`, - } - } - } - }; - - return axios.request(options).then(({ data }: { data: Responses }) => data); -} -``` -
diff --git a/sidebars.js b/sidebars.js index 1a9fa9c22..2520b919d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -4808,13 +4808,6 @@ const sidebars = { label: 'Authentication', className: 'sidebarItem', items: [ - { - type: 'link', - label: 'Login', - href: '/guidelines/user-api#login', - customProps: { method: 'POST' }, - className: 'sidebarItem' - }, { type: 'link', label: 'OAuth token',