Docs

App Afiliados

Referência da API

...

Nesta página

Listar eventos

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

Retorna uma lista de eventos

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: 0004knrGjQ8uD9wIHVaCWH

  • event
    String

    Tipo de evento

    Ex: evento_verao

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 responsável pelo evento

Ex: 0004knrGjQ8uD9wIHVaCWH
events
Array of objects

Array de eventos agrupados por afiliado e data
date
String

Data da operação

Ex: 22-05-2024
events
Object

Operações agrupadas pelo nome do evento
nome_do_evento
Object

total_records
Number

Número de operações

Ex: 15
amount_sum
Number

Valor total das operações

Ex: 6159.9
statuses
Object

Status sobre processamento das operações
processed
Object

Operações processadas
total_records
Number

Número operações processadas

Ex: 17
daily_amount
Number

Valor total diário

Ex: 12835.98
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 evento

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

Cria novos eventos

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
events
Array of objects

affiliate_id

Obrigatório

String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event

Obrigatório

String

Nome da ação ou transação realizada

Ex: Boleto
amount

Obrigatório

Number

Valor total da operação

Ex: 100.0
idempotency_key

Obrigatório

String

Chave de idepotência

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

{
  "events": [
    {
      "affiliate_id": "7iCCaotmWlRFig39trAXkB",
      "event": "Boleto",
      "amount": 100.0,
      "idempotency_key": 23231233
    }
  ]
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
Criação bem-sucedida
created
Number

Número de eventos criados

Ex: 12
errors
Array of objects

event
Object

affiliate_id
String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event
String

Nome da ação ou transação realizada

Ex: Boleto
amount
Number

Valor total da operação

Ex: 100.0
position
Number

Posição do evento na lista enviada

Ex: 1
message
String

Mensagem de erro

Ex: Validation error: The property '#/idempotency_key' of type null did not match the following type: string
422
Unprocessable Entity
created
Number

Número de eventos criados

Ex: 0
errors
Array of objects

event
Object

affiliate_id
String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event
String

Nome da ação ou transação realizada

Ex: Boleto
amount
Number

Valor total da operação

Ex: 100.0
position
Number

Posição do evento na lista enviada

Ex: 1
message
String

Mensagem de erro

Ex: Validation error: The property '#/idempotency_key' of type null did not match the following type: string
500
Internal Server Error
errors
String

Mensagem de erro

Ex: Internal Server Error