Docs

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

Parâmetros de Query

  • name
    String

    Nome do afiliado

    Ex: Influencer instagram

  • document
    String

    CPF/CNPJ do afiliado

    Ex: 38235467828

  • email
    String

    Email do afiliado

    Ex: [email protected]

  • phone_number
    String

    Telefone do afiliado

    Ex: 5511911112222

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
success
Array of objects

id
String

Identificador único do afiliado

Ex: 5N8wqsUjlwlxtx1tIqoP1a
name
String

Nome do afiliado

Ex: Primo Rico
workspace_id
String

ID do espaço de trabalho associado ao afiliado

Ex: 6AaVMPZBMTMweShgqdA7nR
email
String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
document
String

Documento do afiliado

Ex: 50949740098
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
parent_affiliate
Object

id
String

Identificador único do afiliado indicador

Ex: 0XNFWtBURoI7O5vinlYjS2
name
String

Nome do afiliado indicador

Ex: Primo Rico
email
String

Email do afiliado indicador

Ex: [email protected]
document
String

Documento do afiliado indicador

Ex: 50949740098
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

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
email

Obrigatório

String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
parent_affiliate_id
String

ID do afiliado que indicou

Ex: 0XNFWtBURoI7O5vinlYjS2
Exemplo 
1
2
3
4
5
6
7
8
9

{
  "affiliate": {
    "name": "Influencer instagram",
    "document": "38235467828",
    "email": "[email protected]",
    "phone_number": "11942424545",
    "parent_affiliate_id": "0XNFWtBURoI7O5vinlYjS2"
  }
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
201
Created
id
String

Identificador único do afiliado

Ex: 5N8wqsUjlwlxtx1tIqoP1a
name
String

Nome do afiliado

Ex: Primo Rico
workspace_id
String

ID do espaço de trabalho associado ao afiliado

Ex: 6AaVMPZBMTMweShgqdA7nR
email
String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
document
String

Documento do afiliado

Ex: 50949740098
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
parent_affiliate
Object

id
String

Identificador único do afiliado indicador

Ex: 0XNFWtBURoI7O5vinlYjS2
name
String

Nome do afiliado indicador

Ex: Primo Rico
email
String

Email do afiliado indicador

Ex: [email protected]
document
String

Documento do afiliado indicador

Ex: 50949740098
422
Unprocessable Entity
name
Array of strings

Ex: [não pode ficar em branco]
document
Array of strings

Ex: [não pode ficar em branco]
email
Array of strings

Ex: [não pode ficar em branco,não é válido]
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

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
String

Nome do afiliado

Ex: Influencer instagram
document
String

CPF/CNPJ do afiliado

Ex: 38235467828
email
String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
parent_affiliate_id
String

ID do afiliado que indicou

Ex: 5N8wqsUjlwlxtx1tIqoP1a
Exemplo 
1
2
3
4
5
6
7
8
9

{
  "affiliate": {
    "name": "Influencer instagram",
    "document": "38235467828",
    "email": "[email protected]",
    "phone_number": "11942424545",
    "parent_affiliate_id": "5N8wqsUjlwlxtx1tIqoP1a"
  }
}

Parâmetros de Path

  • id

    Obrigatório

    String

    ID do afiliado

    Ex: 5EufttluGZIPaQKN5PF4X4

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
id
String

Identificador único do afiliado

Ex: 5N8wqsUjlwlxtx1tIqoP1a
name
String

Nome do afiliado

Ex: Primo Rico
workspace_id
String

ID do espaço de trabalho associado ao afiliado

Ex: 6AaVMPZBMTMweShgqdA7nR
email
String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
document
String

Documento do afiliado

Ex: 50949740098
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
parent_affiliate
Object

id
String

Identificador único do afiliado indicador

Ex: 0XNFWtBURoI7O5vinlYjS2
name
String

Nome do afiliado indicador

Ex: Primo Rico
email
String

Email do afiliado indicador

Ex: [email protected]
document
String

Documento do afiliado indicador

Ex: 50949740098
422
Unprocessable Entity
name
Array of strings

Ex: ["não pode ficar em branco"]
document
Array of strings

Ex: ["não pode ficar em branco"]
email
Array of strings

Ex: ["não pode ficar em branco","não é válido"]
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

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

    Ex: 5EufttluGZIPaQKN5PF4X4

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
message
String

Mensagem de sucesso ao excluir afiliado

Ex: Affiliate deleted successfully.
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

Campanhas associadas a um afiliado

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

Retorna uma lista de relações entre campanhas e afiliados

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

Parâmetros de Query

  • affiliate_id
    String

    ID do afiliado

    Ex: 5EufttluGZIPaQKN5PF4X4

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
success
Array of objects

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