Skip to content

AppendixApi.md

Latest commit

 

History

History
236 lines (156 loc) · 5.11 KB

AppendixApi.md

File metadata and controls

236 lines (156 loc) · 5.11 KB
Raw

AppendixApi

All URIs are relative to https://api.dataforseo.com

Method HTTP request Description
userData GET /v3/appendix/user_data
errors GET /v3/appendix/errors
webhookResend POST /v3/appendix/webhook_resend
appendixStatus GET /v3/appendix/status

userData

AppendixUserDataResponseInfo userData()

Example

 const username = 'USERNAME';
 const password = 'PASSWORD';

 let api = new AppendixApi("https://api.dataforseo.com", {
   fetch: (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     const token = btoa(`${username}:${password}`);
     const authHeader = { 'Authorization': `Basic ${token}` };

     const newInit: RequestInit = {
       ...init,
       headers: {
       ...init?.headers,
       ...authHeader,
     }
   };

   return fetch(url, newInit);
   }
 });

 let response = await api.userData();

Parameters

This endpoint does not need any parameter.

Return type

AppendixUserDataResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

errors

AppendixErrorsResponseInfo errors()

Example

 const username = 'USERNAME';
 const password = 'PASSWORD';

 let api = new AppendixApi("https://api.dataforseo.com", {
   fetch: (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     const token = btoa(`${username}:${password}`);
     const authHeader = { 'Authorization': `Basic ${token}` };

     const newInit: RequestInit = {
       ...init,
       headers: {
       ...init?.headers,
       ...authHeader,
     }
   };

   return fetch(url, newInit);
   }
 });

 let response = await api.errors();

Parameters

This endpoint does not need any parameter.

Return type

AppendixErrorsResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

webhookResend

AppendixWebhookResendResponseInfo webhookResend()

Example

 const username = 'USERNAME';
 const password = 'PASSWORD';

 let api = new AppendixApi("https://api.dataforseo.com", {
   fetch: (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     const token = btoa(`${username}:${password}`);
     const authHeader = { 'Authorization': `Basic ${token}` };

     const newInit: RequestInit = {
       ...init,
       headers: {
       ...init?.headers,
       ...authHeader,
     }
   };

   return fetch(url, newInit);
   }
 });

 let task = new AppendixWebhookResendRequestInfo();
   task.id = "08161139-0001-0066-1000-06491d097ed5";
 let response = await api.webhookResend([task]);

Parameters

Name Type Description Notes
**** List<AppendixWebhookResendRequestInfo[]> [optional]

Return type

AppendixWebhookResendResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

appendixStatus

AppendixStatusResponseInfo appendixStatus()

Example

 const username = 'USERNAME';
 const password = 'PASSWORD';

 let api = new AppendixApi("https://api.dataforseo.com", {
   fetch: (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     const token = btoa(`${username}:${password}`);
     const authHeader = { 'Authorization': `Basic ${token}` };

     const newInit: RequestInit = {
       ...init,
       headers: {
       ...init?.headers,
       ...authHeader,
     }
   };

   return fetch(url, newInit);
   }
 });

 let response = await api.appendixStatus();

Parameters

This endpoint does not need any parameter.

Return type

AppendixStatusResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -