Docs

App Afiliados

Referência da API

...

Nesta página

Consultar campanha

get https://api.affiliates.iugu.com/campaigns/{id}

Consulta uma campanha

Autorizações
oAuthClientCredentials
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • not:required - scopes are not in use

Parâmetros de Path

  • id

    Obrigatório

    String

    ID da campanha

    Ex: 58HKqRy8w2iHoKT91HCIeI

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
id
String

ID da campanha

Ex: 58HKqRy8w2iHoKT91HCIeI
name
String

Nome da campanha

Ex: Campanha de Verão
workspace_id
String

ID da Área de Trabalho

Ex: 6AaVMPZBMTMweShgqdA7nR
event
String

Tipo de evento

Ex: Pix
kind
Integer

Tipo de premiação (percent: 1, fixed: 2)

Ex: 2
amount
Number

Valor da premiação por evento

Ex: 0.1
start_date
String

Data de início da campanha

Ex: 2023-12-09
end_date
String

Data de término da campanha

Ex: 2023-12-13
level_config
Object

Configuração de níveis de premiação
level_1
Integer

Configuração do nível 1

Ex: 50
level_2
Integer

Configuração do nível 2

Ex: 50
affiliates
Array of strings

Array de ID de afiliados

Ex: ["5EufttluGZIPaQKN5PF4X4", "0cxvXAS3uPZut5z1mVKI20"]
created_at
String

Data de criação da campanha

Ex: 2023-12-08T16:41:22.922Z
updated_at
String

Data de atualização da campanha

Ex: 2023-12-08T16:44:02.572Z
401
Unauthorized
status
String

Ex: 401
title
String

Ex: JWT VALIDATION ERROR
detail
String

Ex: Signature has expired
404
Not Found
message
String

Ex: Registro não encontrado.
500
Internal Server Error
status
String

Ex: 500
title
String

Ex: Internal Server Error
detail
String

Ex: Internal Error, try again later

Adicionar afiliado à campanha

post https://api.affiliates.iugu.com/campaign_affiliates

Adiciona afiliado à campanha

Autorizações
oAuthClientCredentials
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • not:required - scopes are not in use

Schema Obrigatório

Tipo de conteúdo: application/json
campaign_affiliate
Object

campaign_id

Obrigatório

String

ID da campanha

Ex: 7cXdkOCm6T0AdctrTWPlGI
affiliate_id

Obrigatório

String

ID do afiliado

Ex: 78tMFXyBPArVWHw33blSDe
Exemplo 
1
2
3
4
5
6

{
  "campaign_affiliate": {
    "campaign_id": "7cXdkOCm6T0AdctrTWPlGI",
    "affiliate_id": "78tMFXyBPArVWHw33blSDe"
  }
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
201
Created
affiliate_id
String

ID do afiliado

Ex: 78tMFXyBPArVWHw33blSDe
affiliate_name
String

Nome do afiliado

Ex: Influencer
campaign_id
String

ID da campanha

Ex: 7cXdkOCm6T0AdctrTWPlGI
campaign_name
String

Nome da campanha

Ex: Campanha de verão
campaign_event
String

Evento da campanha

Ex: BlackFriday
created_at
String

Data de criação da relação entre campanha e afiliado

Ex: 2023-12-08T16:41:22.922Z
updated_at
String

Data de atualização da relação entre campanha e afiliado

Ex: 2023-12-08T16:44:02.572Z
422
Unprocessable Entity
campaign
Array of strings

Ex: ["must exist"]
affiliate
Array of strings

Ex: ["must exist"]
401
Unauthorized
status
String

Ex: 401
title
String

Ex: JWT VALIDATION ERROR
detail
String

Ex: Signature has expired
500
Internal Server Error
status
String

Ex: 500
title
String

Ex: Internal Server Error
detail
String

Ex: Internal Error, try again later

Remover afiliado da campanha

delete https://api.affiliates.iugu.com/campaign_affiliates/{campaign_id}/{affiliate_id}

Remove afiliado da campanha

Autorizações
oAuthClientCredentials
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • not:required - scopes are not in use

Parâmetros de Path

  • campaign_id

    Obrigatório

    String

    ID da campanha

    Ex: 7FLqqKqggYFxt1nk2NW3jw

  • affiliate_id

    Obrigatório

    String

    ID do afiliado

    Ex: 1Y7fL0IL1aJjfSt3Dp4GNO

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
message
String

Mensagem de sucesso ao remover afiliado da campanha

Ex: Relationship between campaign and affiliate deleted successfully.
422
Unprocessable Entity
campaign
Array of strings

Ex: ["must exist"]
affiliate
Array of strings

Ex: ["must exist"]
401
Unauthorized
status
String

Ex: 401
title
String

Ex: JWT VALIDATION ERROR
detail
String

Ex: Signature has expired
500
Internal Server Error
status
String

Ex: 500
title
String

Ex: Internal Server Error
detail
String

Ex: Internal Error, try again later