Docs Afiliados

App Afiliados

Referência da API

...

Nesta página

Listar campanhas

get https://api.affiliates.iugu.com/campaigns

Retorna uma lista de campanhas

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

Respostas
200
OK
data
Array

id
String

ID da campanha

Ex: a4a0388a-ed26-4f73-b9d8-d070399f0a46
type
String

Tipo de recurso ("campaign")

Ex: campaign
attributes
Object

name
String

Nome da campanha

Ex: Campanha de Verão
workspace_id
String

ID da Área de Trabalho

Ex: bcaee2c9-7a3c-4941-86ea-2dd5e7158845
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
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
relationships
Object

affiliates
Object

data
Array

id
String

Ex: 4054c1d4-2ed3-4176-bd99-b0fc5b5a7f58
type
String

Ex: affiliate
meta
Object

total
Integer

Total de campanhas

Ex: 1
links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/campaigns
current
String

URL da página atual

Ex: https://affiliates.iugu.com/api/campaigns?page[number]=1
400
Bad Request
errors
Array

status
String

Ex: 400
source
Null

title
String

Ex: Bad Request
detail
Null

404
Not Found
errors
Array

status
String

Ex: 404
source
Null

title
String

Ex: Not Found
detail
Null

500
Internal Server Error
errors
Array

status
String

Ex: 500
source
Null

title
String

Ex: Internal Server Error
detail
Null

Criar campanha

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

Cria uma nova 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
Object

name

Obrigatório

String

Nome da campanha

Ex: Campanha de Verão
workspace_id

Obrigatório

String

ID da Área de Trabalho

Ex: bcaee2c9-7a3c-4941-86ea-2dd5e7158845
event

Obrigatório

String

Tipo de evento

Ex: Pix
kind

Obrigatório

Integer

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

Ex: 2
amount

Obrigatório

Number

Valor da premiação por evento

Ex: 0.1
start_date

Obrigatório

String

Data de início da campanha

Ex: 2023-12-09
end_date

Obrigatório

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
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "campaign": {
    "name": "Campanha de Verão",
    "workspace_id": "bcaee2c9-7a3c-4941-86ea-2dd5e7158845",
    "event": "Pix",
    "kind": 2,
    "amount": 0.1,
    "start_date": "2023-12-09",
    "end_date": "2023-12-13",
    "level_config": {
      "level_1": 50,
      "level_2": 50
    }
  }
}

Respostas
201
Created
data
Object

id
String

ID da campanha

Ex: b130eff7-85c2-47b0-8608-00edb2f83ecd
type
String

Tipo de recurso ("campaign")

Ex: campaign
attributes
Object

name
String

Nome da campanha

Ex: trau
workspace_id
String

ID da Área de Trabalho

Ex: bcaee2c9-7a3c-4941-86ea-2dd5e7158845
event
String

Tipo de evento

Ex: venda
kind
Integer

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

Ex: 1
amount
Number

Valor da premiação

Ex: 100.2
start_date
String

Data de início da campanha

Ex: 2024-01-10
end_date
String

Data de término da campanha

Ex: 2024-01-17
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
created_at
String

Data de criação da campanha
updated_at
String

Data de atualização da campanha
relationships
Object

affiliates
Object

data
Array

id
String

Ex: 4054c1d4-2ed3-4176-bd99-b0fc5b5a7f58
type
String

Ex: affiliate
links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/campaigns
422
Unprocessable Entity
errors
Array

status
String

Código do erro

Ex: 422
source
Object

pointer
String

Ex: /data/attributes/name
title
String

Título do erro

Ex: Unprocessable Entity
detail
String

Mensagem de erro

Ex: Nome não pode ficar em branco
code
String

Código do erro

Ex: blank
400
Bad Request
errors
Array

status
String

Ex: 400
source
Null

title
String

Ex: Bad Request
detail
Null

500
Internal Server Error
errors
Array

status
String

Ex: 500
source
Null

title
String

Ex: Internal Server Error
detail
Null

Atualizar campanha

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

Atualiza uma 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
Object

name
String

Nome da campanha

Ex: Campanha de Verão
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
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
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12

{
  "campaign": {
    "name": "Campanha de Verão",
    "event": "Pix",
    "kind": 2,
    "amount": 0.1,
    "level_config": {
      "level_1": 50,
      "level_2": 50
    }
  }
}

Parâmetros de Path

  • id

    Obrigatório

    String

    ID da campanha

Respostas
200
OK
data
Object

id
String

ID da campanha

Ex: b130eff7-85c2-47b0-8608-00edb2f83ecd
type
String

Tipo de recurso ("campaign")

Ex: campaign
attributes
Object

name
String

Nome da campanha

Ex: trau
workspace_id
String

ID da Área de Trabalho

Ex: bcaee2c9-7a3c-4941-86ea-2dd5e7158845
event
String

Tipo de evento

Ex: venda
kind
Integer

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

Ex: 1
amount
Number

Valor da premiação

Ex: 100.2
start_date
String

Data de início da campanha

Ex: 2024-01-10
end_date
String

Data de término da campanha

Ex: 2024-01-17
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
created_at
String

Data de criação da campanha
updated_at
String

Data de atualização da campanha
relationships
Object

affiliates
Object

data
Array

id
String

Ex: 4054c1d4-2ed3-4176-bd99-b0fc5b5a7f58
type
String

Ex: affiliate
links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/campaigns/{id}
422
Unprocessable Entity
errors
Array

status
String

Código do erro

Ex: 422
source
Object

pointer
String

Ex: /data/attributes/name
title
String

Título do erro

Ex: Unprocessable Entity
detail
String

Mensagem de erro

Ex: Nome não pode ficar em branco
code
String

Código do erro

Ex: blank
400
Bad Request
errors
Array

status
String

Ex: 400
source
Null

title
String

Ex: Bad Request
detail
Null

404
Not Found
errors
Array

status
String

Ex: 404
source
Null

title
String

Ex: Not Found
detail
Null

500
Internal Server Error
errors
Array

status
String

Ex: 500
source
Null

title
String

Ex: Internal Server Error
detail
Null

Deletar campanha

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

Exclui 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

Respostas
200
OK
data
Object

id
String

ID da campanha

Ex: b130eff7-85c2-47b0-8608-00edb2f83ecd
type
String

Tipo de recurso ("campaign")

Ex: campaign
attributes
Object

name
String

Nome da campanha

Ex: trau
workspace_id
String

ID da Área de Trabalho

Ex: bcaee2c9-7a3c-4941-86ea-2dd5e7158845
event
String

Tipo de evento

Ex: venda
kind
Integer

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

Ex: 1
amount
Number

Valor da premiação

Ex: 100.2
start_date
String

Data de início da campanha

Ex: 2024-01-10
end_date
String

Data de término da campanha

Ex: 2024-01-17
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
created_at
String

Data de criação da campanha
updated_at
String

Data de atualização da campanha
relationships
Object

affiliates
Object

data
Array

id
String

Ex: 4054c1d4-2ed3-4176-bd99-b0fc5b5a7f58
type
String

Ex: affiliate
links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/campaigns/{id}
404
Not Found
errors
Array

status
String

Ex: 404
source
Null

title
String

Ex: Not Found
detail
Null

500
Internal Server Error
errors
Array

status
String

Ex: 500
source
Null

title
String

Ex: Internal Server Error
detail
Null