Partner API

We offer this set of APIs in order to provide you access to all the functionalities that can be used through the Partner Interface and the Agent Backoffice.

This API originated from our own Partner Interface application (partners.aklamio.com) but is open to be used by any partner in order to automate common tasks like creating, confirming or rejecting conversions for referral and cashback campaigns.

In order to maintain an authentication state the Aklamio Partner API uses JSON Web Tokens. A token can be obtained using the sign in endpoint with a username and password:

            curl -i -X POST \
-H 'Content-Type: application/json' \
-H 'Partner: Partner' \
-d '{"email":"${account_manager_email}","password":"${account_manager_password}"}' \
https://api.aklamio.com/api/v2/partners/account_managers/sign_in
          

JWT can be found in the Headers response:

            ...
authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X21hbmFnZXJfZW1haWwiOiJzdGVm ...
...
          

The JWTs returned by the API expire after 24 hours. If you need a longer lasting token for your application, please contact your Partner Success Manager.

Include the JWT as a HTTP Authorization header in your requests. It's mandatory to add a custom 'Partner' HTTP header to the request, with an arbitrary string 'Partner' identifying you as a client. The Partner API makes the functionality of the Aklamio Partner interface available at a single GraphQL endpoint:

            curl -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ${JWT}' \
-H 'Partner: Partner' \
-d '
{
  promotion {
    id
    title
  }
}
'
https://api.aklamio.com/api/v2/partners/graphql
          

The Aklamio GraphQL API can be used to perform:

• Queries for data retrieval.
• Mutations for creating and updating data.

Queries

Aklamio GraphQL Schema outlines which objects and fields are available for clients to query and their corresponding data types.

Example

            query {
  promotion {
    id
    title
    uid
    url
    balance
    currency
    backoffice {
      allowCashback
      allowCashbackCode
      allowEmailAndCode
      allowFollowerEmail
      allowInvite
      allowOnlyCode
      allowOnlyEmail
      category {
        label
        legend
      }
      format
      hasIntro
      id
      intro
      inviteEmail {
        label
        legend
      }
      locale
      showSupportDocument
      supportDocumentLabel
      supportDocumentUrl
      supportPhoneNumber
      title
    }
  }
}
          

Mutations

Mutations make changes to data. We can create or update new records.

Mutations have:

• Inputs. For example, arguments, such as which conversions you'd like to confirm.
• Return statements. That is, what you'd like to get back when it's successful.

Creation mutations

Example

            mutation {
  createConversion(
    additionalFields: {
      shop_id: "123456"
    },
    category: "category_1",
    couponCode: "12345678",
    followerEmail: "follower@example.com",
    isCashback: false,
    orderId: "205ca310-5d04-41db-a525-c451761bb5e1",
    orderOption: "cable",
    recommenderEmail: "recommender@example.com"
  ) {
    conversion {
      id
    }
  }
}
          

Update mutations

Example

            mutation {
  confirmConversions(orderIds: ["987654"]) {
    conversions {
      id
      orderId
      state
    }
  }
}
          

Promotion Permalink

When managing multiple promotions, some queries and mutations require a permalink input of the promotion which is being targeted.

It is recommended to include this input even when managing a single promotion, as no changes will be required in the future if more promotions are created.

Query Example

            query {
  promotions(permalinks: ["promotion_permalink", "promotion2_permalink")] {
    id
    title
  }
}
          

Mutation Example

            mutation {
  confirmSalesRequests(
    orderIds: ["1234", "9876"],
    promotionPermalink: "promotion_permalink"
  ) {
    salesRequests {
      id
      state
    }
  }
}
          

This documentation is self-generated based on Aklamio current GraphQL schema.

The API can be explored interactively using the GraphiQL IDE.

Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL.

Object types

Object types represent the resources that Aklamio’s GraphQL API can return. They contain fields. Each field has its own type, which will either be one of the basic GraphQL scalar types (e.g.: String or Boolean) or other object types.

For more information, see Object Types and Fields on graphql.org.

AccountingEntriesPage

Represents a page of accounting entries

AccountingEntriesRow

Represents a pagination unit containing one or many accounting entries

AccountingEntry

Represents an Accounting Entry

AdditionalField

Represents a backoffice configuration for the additional field

Advertiser

Represents an advertiser configuration

Backoffice

Represents an agent backoffice configuration

Backoffices

Backoffices associated to a promotion, keyed by sales channel.

BoAgentMetrics

Represents various metrics for a backoffice agent

BoOrderMetrics

Represents an order for backoffice metrics

BoOrdersListMetrics

Represents a list of orders for backoffice metrics

Brand

Represents a promotion information with related advertiser and conversions

Campaign

Represents a campaign attached to a promotion

Category

Represents a backoffice configuration for the category field

Cause

Represents cause object

CauseCategory

Represents cause category object

CausesWrapper

Wrapper object to bring more details around list of causes like count, page and per page

ConditionTemplate

Represents a template for condition in reward rules

ConditionalDashboards

Represents conditional dashboards object

ConfirmPayload

Autogenerated return type of Confirm

ConfirmSalesRequestPayload

Autogenerated return type of ConfirmSalesRequest

ConfirmSalesRequestsPayload

Autogenerated return type of ConfirmSalesRequests

Conversion

Represents a conversion information

Cost

Represents a cost information

CreateBackofficeSalesRequestPayload

Autogenerated return type of CreateBackofficeSalesRequest

CreateCampaignPayload

Autogenerated return type of CreateCampaign

CreateConversionPayload

Autogenerated return type of CreateConversion

CreatePromotionCausesPayload

Autogenerated return type of CreatePromotionCauses

CreateRulePlanPayload

Autogenerated return type of CreateRulePlan

CreateSalesRequestPayload

Autogenerated return type of CreateSalesRequest

CreateUserPayload

Autogenerated return type of CreateUser

Customer

Represents customer object

DataflowCheckpoint

Represents status info of individual checkpoint

DestroyCampaignPayload

Autogenerated return type of DestroyCampaign

EmailTemplate

Represents an email template

EmailTemplateType

Represents an email template type

FeatureFlag

Information about growthbook features

FieldError

Represents a backoffice configuration for the field error

FollowerEmailCashback

Represents a backoffice configuration for the follower email cashback field

FollowerEmailReferral

Represents a backoffice configuration for the follower email referral field

GenerateApiKeyPayload

Autogenerated return type of GenerateApiKey

IntegrationMeta

Represents the status of additional script used by client alongwith trackingjs

InviteEmail

Represents a backoffice configuration for the invite email field

ItemCategory

Category of purchased product

ItemName

Name of purchased product

ItemPrice

Price of purchased product

ItemSKU

SKU of purchased product

LineItem

Represents a Sales Request Line Item

MetricResult

Represents metrics results including current, past, and relative change

OrderId

Represents a backoffice configuration for the order id field

OrderOption

Represents a backoffice configuration for the order options field

Promotion

Represents a promotion information with related advertiser and conversions

PromotionCauses

Represents promotion causes

PromotionVouchers

Represents promotion vouchers response type, including featured and non-featured vouchers

PromotionVouchersCount

Represents promotion vouchers count type, giving total number of vouchers

RecreateSalesRequestPayload

Autogenerated return type of RecreateSalesRequest

ReferrerEmail

Represents a backoffice configuration for the referrer email field

RejectPayload

Autogenerated return type of Reject

RejectSalesRequestsPayload

Autogenerated return type of RejectSalesRequests

RejectSupportRequestPayload

Autogenerated return type of RejectSupportRequest

RequestLog

Represents the primary detail of the request/sales event log from trackingjs

RevertEmailTemplatePayload

Autogenerated return type of RevertEmailTemplate

RevokeApiKeyPayload

Autogenerated return type of RevokeApiKey

RewardCodeCashback

Represents a backoffice configuration for the reward code cashback field

RewardCodeReferral

Represents a backoffice configuration for the reward code referral field

RewardCosts

Represents a Reward Costs

RewardRule

Represents a reward rule information

RewardTemplate

Represents a template for reward in reward rules

RulePlan

Represents a rule plan information

SalesRequest

Represents a Sales Request

SupportRequest

Represents a Support Request

SurroundingCampaigns

Campaigns before and after a specific datetime

TrailingConversions

Totals of conversions for current and previous period

TreckerFlowCheckpoint

Represents different checkpoints associated with trecker integration

UpdateCampaignPayload

Autogenerated return type of UpdateCampaign

UpdateEmailTemplatesPayload

Autogenerated return type of UpdateEmailTemplates

UpdatePromotionCausesPayload

Autogenerated return type of UpdatePromotionCauses

UpdatePromotionPayload

Autogenerated return type of UpdatePromotion

UpdatePromotionVouchersPayload

Autogenerated return type of UpdatePromotionVouchers

UpdateRulePlanPayload

Autogenerated return type of UpdateRulePlan

UpdateSalesRequestPayload

Autogenerated return type of UpdateSalesRequest

User

Represents a user information

Version

Represents the information regarding change in the record

Voucher

Represents voucher object

VouchersWrapper

Wrapper object to bring more details around list of vouchers like count, page and per page

The mutation type defines how GraphQL operations change data. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

For more information, see Mutations on graphql.org.

confirmConversions

Confirm conversions mutation

Input Fields

Return Fields

confirmSalesRequest

Confirm sales requests mutation

Input Fields

Return Fields

confirmSalesRequests

Confirm sales requests mutation

Input Fields

Return Fields

createBackofficeSalesRequest

Create a sales requests from backoffice

Input Fields

Return Fields

createCampaign

Create a campaign

Input Fields

Return Fields

createConversion

Create conversion mutation

Input Fields

Return Fields

createPromotionCauses

Create promotion causes

Input Fields

Return Fields

createRulePlan

Create rule plan mutation

Input Fields

Return Fields

createSalesRequest

Create sales request mutation

Input Fields

Return Fields

createUser

Create user mutation

Input Fields

Return Fields

destroyCampaign

Destroy a campaign

Input Fields

Return Fields

generateApiKey

Generate API key for brand for server to server tracking

Input Fields

Return Fields

recreateSalesRequest

Recreate sales request mutation

Input Fields

Return Fields

rejectConversions

Reject conversions mutation

Input Fields

Return Fields

rejectSalesRequests

Reject sales requests mutation

Input Fields

Return Fields

rejectSupportRequests

Reject support requests mutation

Input Fields

Return Fields

revertEmailTemplate

Revert brand email template to global template configuration

Input Fields

Return Fields

revokeApiKey

Remove Api key from brand

Input Fields

Return Fields

updateCampaign

Update a campaign

Input Fields

Return Fields

updateEmailTemplates

Update email templates

Input Fields

Return Fields

updatePromotion

Update promotion

Input Fields

Return Fields

updatePromotionCauses

Update promotion causes

Input Fields

Return Fields

updatePromotionVouchers

Update promotion vouchers

Input Fields

Return Fields

updateRulePlan

Update rule plan mutation

Input Fields

Return Fields

updateSalesRequest

Update sales request mutation

Input Fields

Return Fields

For more information, see Enumeration types on graphql.org.

ClosingReason

Represents an enum type for support request closing reason.

ConditionScope

Represents a condition scope.

OpeningReason

Represents an enum type for support request opening reason.

ProgramType

Represents program type

RewardEvaluationMode

Represent the evaluation modes for a reward.

RewardType

Represents reward type

SalesChannel

Represents the sales channel

State

Represents an enum type for state

SupportRequestState

Represents an enum type for support request state.

For more information, see Input types on graphql.org.

AccountingEntriesFiltersInput

Filters for accounting entries page

Input Fields

CampaignCreateInput

Input type for campaign creation

Input Fields

CampaignUpdateInput

Input type for campaign update

Input Fields

CauseInput

Input type for a cause

Input Fields

DateRangeInput

Date range filter with from and to dates

Input Fields

EmailTemplateUpdateInput

Input type for updating email templates

Input Fields

LineItemBoInput

Input type for line item for backoffice

Input Fields

LineItemInput

Input type for line item

Input Fields

RewardRuleInput

Input type for reward rule

Input Fields

RulePlanUpdateInput

Input type for rule plan update

Input Fields

VoucherInput

Input type for a voucher

Input Fields