Docs Afiliados

App Afiliados

Referência da API

...

Nesta página

Listar Afiliados

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

Retorna uma lista de afiliados

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

Identificador único do afiliado

Ex: 489bdd40-a179-4a8a-9708-34e61d35bec0
type
String

Tipo de recurso ("affiliate")

Ex: affiliate
attributes
Object

name
String

Nome do afiliado

Ex: Primo Rico
document
String

Documento do afiliado

Ex: 50949740098
workspace_id
String

ID do espaço de trabalho associado ao afiliado

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

ID do afiliado pai

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

Data e hora de criação do afiliado

Ex: 2023-12-20T17:46:49.461Z
updated_at
String

Data e hora da última atualização do afiliado

Ex: 2023-12-22T19:06:50.487Z
relationships
Object

campaigns
Object

data
Array

id
String

type
String

Ex: campaign
parent_affiliate
Object

data
Object

id
String

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

Ex: affiliate
child_affiliates
Object

data
Array

id
String

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

Ex: affiliate
meta
Object

total
Integer

Total de afiliados

Ex: 1
links
Object

self
String

URL da página atual

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

URL da página atual

Ex: https://affiliates.iugu.com/api/affiliates?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 Afiliados

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

Cria um novo afiliado

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
affiliate
Object

name

Obrigatório

String

Nome do afiliado

Ex: Influencer instagram
document

Obrigatório

String

CPF/CNPJ do afiliado

Ex: 38235467828
workspace_id

Obrigatório

String

ID da Área de Trabalho

Ex: 59c596f1-17a0-4aa4-83a4-4710f273f7ed
parent_affiliate_id
String

ID do afiliado que indicou

Ex: 489bdd40-a179-4a8a-9708-34e61d35bec0
Exemplo 
1
2
3
4
5
6
7
8

{
  "affiliate": {
    "name": "Influencer instagram",
    "document": "38235467828",
    "workspace_id": "59c596f1-17a0-4aa4-83a4-4710f273f7ed",
    "parent_affiliate_id": "489bdd40-a179-4a8a-9708-34e61d35bec0"
  }
}

Respostas
201
Created
data
Object

id
String

ID do afiliado

Ex: 279ece16-b6d4-4c8c-8887-5d619a921697
type
String

Tipo de recurso ("affiliate")

Ex: affiliate
attributes
Object

name
String

Nome do afiliado

Ex: TESTE-DOC
document
String

CPF/CNPJ do afiliado

Ex: 73987554061
workspace_id
String

ID da Área de Trabalho

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

Data de criação do afiliado

Ex: 2024-01-10T18:25:51.965Z
updated_at
String

Data de atualização do afiliado

Ex: 2024-01-10T18:25:51.965Z
relationships
Object

campaigns
Object

data
Array

id
String

type
String

parent_affiliate
Object

data
Object

id
String

type
String

child_affiliates
Object

data
Array

id
String

type
String

links
Object

self
String

URL da página atual

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

status
String

Ex: 422
source
Object

pointer
String

Ex: /data/attributes/document
title
String

Ex: Unprocessable Entity
detail
String

Ex: CPF/CNPJ já está em uso
code
String

Ex: taken
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 Afiliados

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

Atualiza um afiliado

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
affiliate
Object

name

Obrigatório

String

Nome do afiliado

Ex: Influencer instagram
document

Obrigatório

String

CPF/CNPJ do afiliado

Ex: 38235467828
parent_affiliate_id
String

ID do afiliado que indicou

Ex: 489bdd40-a179-4a8a-9708-34e61d35bec0
Exemplo 
1
2
3
4
5
6
7

{
  "affiliate": {
    "name": "Influencer instagram",
    "document": "38235467828",
    "parent_affiliate_id": "489bdd40-a179-4a8a-9708-34e61d35bec0"
  }
}

Parâmetros de Path

  • id

    Obrigatório

    String

    ID do afiliado

Parâmetros de Query

  • name

    Obrigatório

    String

    Nome do afiliado

  • document

    Obrigatório

    String

    CPF/CNPJ do afiliado

  • parent_affiliate_id
    String

    ID do afiliado que indicou

Respostas
200
OK
data
Object

id
String

ID do afiliado

Ex: 279ece16-b6d4-4c8c-8887-5d619a921697
type
String

Tipo de recurso ("affiliate")

Ex: affiliate
attributes
Object

name
String

Nome do afiliado

Ex: Troca denovo
document
String

CPF/CNPJ do afiliado

Ex: 73987554061
workspace_id
String

ID da Área de Trabalho

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

ID do afiliado que indicou

Ex: 489bdd40-a179-4a8a-9708-34e61d35bec0
created_at
String

Data de criação do afiliado

Ex: 2024-01-10T18:25:51.965Z
updated_at
String

Data de atualização do afiliado

Ex: 2024-01-10T18:47:12.339Z
relationships
Object

campaigns
Object

data
Array

id
String

type
String

parent_affiliate
Object

data
Object

id
String

type
String

child_affiliates
Object

data
Array

id
String

type
String

links
Object

self
String

URL da página atual

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

status
String

Ex: 422
source
Object

pointer
String

Ex: /data/attributes/name
title
String

Ex: Unprocessable Entity
detail
String

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

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

Excluir Afiliados

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

Exclui um afiliado

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 do afiliado

Respostas
200
OK
data
Object

id
String

ID do afiliado

Ex: 279ece16-b6d4-4c8c-8887-5d619a921697
type
String

Tipo de recurso ("affiliate")

Ex: affiliate
attributes
Object

name
String

Nome do afiliado

Ex: Troca denovo
document
String

CPF/CNPJ do afiliado

Ex: 73987554061
workspace_id
String

ID da Área de Trabalho

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

ID do afiliado que indicou

Ex: 489bdd40-a179-4a8a-9708-34e61d35bec0
created_at
String

Data de criação do afiliado

Ex: 2024-01-10T18:25:51.965Z
updated_at
String

Data de atualização do afiliado

Ex: 2024-01-10T18:47:12.339Z
relationships
Object

campaigns
Object

data
Array

id
String

type
String

parent_affiliate
Object

data
Object

id
String

type
String

child_affiliates
Object

data
Array

id
String

type
String

links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/affiliates/{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