Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.43 KB

DataURIApi.md

File metadata and controls

85 lines (55 loc) · 2.43 KB
Raw

wordlift_client.DataURIApi

All URIs are relative to https://api.wordlift.io

Method HTTP request Description
get3 GET /data-uri Get the Web Data URI for a Web Page URL.

get3

get3(u)

Get the Web Data URI for a Web Page URL.

The service will return a Web Data URI only for existing datasets. The Web Data URI is not guaranteed to exist (i.e. it may return 404).

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DataURIApi(api_client)
    u = 'u_example' # str | The Web Page URL.

    try:
        # Get the Web Data URI for a Web Page URL.
        await api_instance.get3(u)
    except Exception as e:
        print("Exception when calling DataURIApi->get3: %s\n" % e)

Parameters

Name Type Description Notes
u str The Web Page URL.

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
303 See Other * Location - Redirect to google login page

[Back to top] [Back to API list] [Back to Model list] [Back to README]