Afiliados - Documentação

Incluir relacionamentos

Passando o parâmetro include você pode incluir relacionamentos na resposta da requisição. Isso pode ser feito em todos endpoints de listagem em que existam relacionamentos disponíveis.

Exemplo de como incluir o relacionamento affiliate na listagem de pagamentos:

  /payments?include=affiliate

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

Retorna uma lista de pagamentos com 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

include

String
Incluir relacionamentos

Respostas

200

data

Array

String

Identificador único do pagamento

Ex: 14393a54-e266-4e4b-a0a8-e2b43d106790

type

String

Tipo de recurso ("payment")

Ex: payment

attributes

Object

amount

Number

Valor total do pagamento

Ex: 11.0

paid_at

String

Data em que o pagamento foi efetivamente realizado

Ex: 2023-12-08T17:47:19.021Z

affiliate_id

String

ID do afiliado beneficiário do pagamento

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

created_at

String

Data de criação do registro

Ex: 2023-12-08T17:47:19.021Z

updated_at

String

Data de atualização do registro

Ex: 2023-12-08T17:47:19.021Z

relationships

Object

affiliate

Object

data

Object

String

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

type

String

Ex: affiliate

included

Array

String

ID do afiliado

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

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

String

type

String

parent_affiliate

Object

data

Object

String

type

String

child_affiliates

Object

data

Array

String

type

String

Filtrar resultados

Você pode filtrar os resultados de uma requisição passando o parâmetro q, uma chave com o nome do campo que deseja filtrar q[nome_do_campo_*] juntamente com um predicado que chamamos de matchers q[*_matcher] e por final o item de comparação do filtro q[nome_do_campo_matcher]=item_de_comparacao. Isso pode ser feito em todos endpoints de listagem.

O padrão de filtro utilizado é o ransack e você pode encontrar informações sobre todos os tipos de matchers disponíveis aqui

Exemplo de como filtrar um item especifico em uma lista pelo id do afiliado:

  /payments?q[affiliate_id_eq]=f98421fd-71be-432c-964d-e3b2d67535af

Exemplo de retorno:

{
    "data": [
        {
            "id": "9455b8d1-a2f1-4ed4-8b04-cb8a42714bed",
            "type": "payment",
            "attributes": {
                "amount": "22.0",
                "paid_at": "2024-01-03T20:02:00.000Z",
                "affiliate_id": "f98421fd-71be-432c-964d-e3b2d67535af",
                "created_at": "2024-01-03T20:02:24.968Z",
                "updated_at": "2024-01-03T20:02:24.968Z"
            },
            "relationships": {
                "affiliate": {
                    "data": {
                        "id": "f98421fd-71be-432c-964d-e3b2d67535af",
                        "type": "affiliate"
                    }
                }
            }
        }
    ],
    "meta": {
        "total": 1
    },
    "links": {
        "self": "https://affiliates.iugu.com/api/payments?q[affiliate_id_eq]=f98421fd-71be-432c-964d-e3b2d67535af",
        "current": "https://affiliates.iugu.com/api/payments?page[number]=1&q[affiliate_id_eq]=f98421fd-71be-432c-964d-e3b2d67535af"
    }
}

App Afiliados

Referência da API

App Afiliados

Referência da API

Nesta página

Incluir relacionamentos

Filtrar resultados