Skip to content

Latest commit

 

History

History
168 lines (120 loc) · 6.3 KB

ZidentifiersApi.md

File metadata and controls

168 lines (120 loc) · 6.3 KB

sparkfly_client.ZidentifiersApi

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

Method HTTP request Description
create_z_identifier GET /v1.0/members/{member_id}/offers/{offer_id}/zidentifiers Create an identifier linking Offer, Member, Channel
get_z_identifier GET /v1.0/members/zidentifiers/{zid} Get Zidentifier

create_z_identifier

ZIdentifierResponse create_z_identifier(member_id, offer_id, x_channel_id)

Create an identifier linking Offer, Member, Channel

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.z_identifier_response import ZIdentifierResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

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

# 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: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.ZidentifiersApi(api_client)
    member_id = 56 # int | The id of the member
    offer_id = 56 # int | The id of the offer
    x_channel_id = 56 # int | The id of the channel

    try:
        # Create an identifier linking Offer, Member, Channel
        api_response = api_instance.create_z_identifier(member_id, offer_id, x_channel_id)
        print("The response of ZidentifiersApi->create_z_identifier:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ZidentifiersApi->create_z_identifier: %s\n" % e)

Parameters

Name Type Description Notes
member_id int The id of the member
offer_id int The id of the offer
x_channel_id int The id of the channel

Return type

ZIdentifierResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 ZIdentifier to create * Cache-Control -
* Content-Length -
* Date -
* Etag -
* Server -
* Set-Cookie -
* X-Auth-Token -
* X-Request-Id -
* X-Runtime -
* X-Ua-Compatible -
401 Unauthorized * Cache-Control -
* Content-Length -
* Content-Type -
* Date -
* Server -
* X-Request-Id -
* X-Runtime -
* X-Ua-Compatible -

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

get_z_identifier

ZIdentifierResponse get_z_identifier(zid)

Get Zidentifier

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.z_identifier_response import ZIdentifierResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

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

# 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: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.ZidentifiersApi(api_client)
    zid = 56 # int | The id linking Offer, Member, and Channel

    try:
        # Get Zidentifier
        api_response = api_instance.get_z_identifier(zid)
        print("The response of ZidentifiersApi->get_z_identifier:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ZidentifiersApi->get_z_identifier: %s\n" % e)

Parameters

Name Type Description Notes
zid int The id linking Offer, Member, and Channel

Return type

ZIdentifierResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Zidentifier to be returned * Cache-Control -
* Content-Length -
* Date -
* Etag -
* Server -
* Set-Cookie -
* X-Auth-Token -
* X-Request-Id -
* X-Runtime -
* X-Ua-Compatible -
401 Unauthorized * Cache-Control -
* Content-Length -
* Content-Type -
* Date -
* Server -
* X-Request-Id -
* X-Runtime -
* X-Ua-Compatible -

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