Recursos para IA
Criar uma nova configuração

Cria colunas e notificadores de entrega para um relatório de Outras operações. Em caso de sucesso, a requisição retorna uma resposta com status 201.

POST

https://api.mercadopago.com/v1/reporting/operations/{reportId}/config
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Path
reportId
string

OBRIGATÓRIO

Tipo de relatório de Outras operações.
activities_collection: Relatório de cobranças.
activities_after_collection: Relatório pós-cobrança.
activities_withdraw: Relatório de retiradas.
Body
structure
object

OBRIGATÓRIO

Estrutura de colunas do relatório.
notifiers
array

OBRIGATÓRIO

Lista de notificadores usados para informar que o relatório está disponível ou para entregar o arquivo gerado. Inclua pelo menos um notificador e defina seu tipo e os dados de conexão correspondentes.
Response parameters
structure
object
Estrutura do relatório criada a partir da requisição de configuração.
notifiers
array
Notificadores criados e associados à estrutura do relatório.
Erros

400Campos inválidos ou notificador malformado.

validation_error

Um ou mais campos da configuração são inválidos, ou um notificador está malformado. Verifique os campos obrigatórios e confirme se data contém os atributos exigidos para o type de notificador selecionado. Depois, envie a requisição novamente.

401Access Token inválido.

invalid_token

O Access Token é inválido, expirou ou não tem permissão de escrita. Verifique o token enviado no header Authorization e seus escopos. Depois, envie a requisição novamente.

409Já existe uma configuração.

configuration_already_exists

Já existe uma configuração ativa para o reportId informado. Consulte-a com GET /config e atualize-a com PUT /config/{structureId} em vez de criar uma nova configuração.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/reporting/operations/{reportId}/config'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-1*********550113-12*********b4773884a*********e8df16347*********786' \
    -d '{
  "structure": {
    "name": "collections-structure",
    "columns": [
      {
        "key": "date_created"
      }
    ],
    "file_format": {
      "column_separator": ",",
      "decimal_separator": ".",
      "date_format": "yyyy-MM-dd",
      "name": "activities_collection",
      "prefix": "activities_"
    },
    "display_timezone": "GMT-05"
  },
  "notifiers": [
    {
      "data": {
        "server": "sftp.myserver.com",
        "port": 22,
        "username": "username",
        "password": "mypassword",
        "remote_dir": "/myfolder"
      },
      "description": "Webhook delivery"
    }
  ]
}'
Response
{
  "structure": {
    "id": "aaaabbbb-1111-2222-3333-ccccddddeeee",
    "name": "collections-structure",
    "columns": [
      {
        "key": "date_created"
      }
    ],
    "notifiers": [
      "11112222-aaaa-bbbb-cccc-333344445555"
    ],
    "scheduled": false,
    "version": 0
  },
  "notifiers": [
    {
      "id": "11112222-aaaa-bbbb-cccc-333344445555",
      "type": "webhook",
      "status": "ACTIVE",
      "version": 0
    }
  ]
}