{
  "info": {
    "_postman_id": "1ca6ac2d-e1e5-46e0-bf94-84797b9e47d1",
    "name": "Koncili - API de Integração Financeira",
    "description": "## Importante\n\nEsta collection foi criada para agilizar o seu processo de integração conosco, servindo como um guia rápido com os principais endpoints e parâmetros.\n\nPara informações aprofundadas, regras de negócio e guias completos, consulte nossa documentação oficial:\n[https://developers.koncili.com/](https://developers.koncili.com/)\n\n## Precisa de ajuda? \n\nPara suporte técnico, contate [suporte@koncili.com](https://mailto:suporte@koncili.com)\n\nEmail: [suporte@koncili.com](https://mailto:suporte@koncili.com)",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_exporter_id": "53419482",
    "_collection_link": "https://go.postman.co/collection/53419482-1ca6ac2d-e1e5-46e0-bf94-84797b9e47d1?source=collection_link"
  },
  "item": [
    {
      "name": "Autenticacao",
      "item": [
        {
          "name": "Gera tokens de acesso JWT",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"credentials\": \"email:senha(base64)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/public/api/auth/token",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "public",
                "api",
                "auth",
                "token"
              ],
              "variable": [
                {
                  "key": "environment",
                  "value": "{{environment}}",
                  "description": " (This can only be one of production,prod)"
                }
              ]
            },
            "description": "Autentica o usuário usando credenciais em Base64 e retorna tokens de acesso e refresh.  \nFormato das credenciais: `Base64(email + \":\" + senha)`"
          },
          "response": []
        },
        {
          "name": "Renova tokens de acesso usando refresh token",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"refreshToken\": \"refresh_token\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/public/api/auth/refresh-token",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "public",
                "api",
                "auth",
                "refresh-token"
              ],
              "variable": [
                {
                  "key": "environment",
                  "value": "{{environment}}",
                  "description": " (This can only be one of production,prod)"
                }
              ]
            },
            "description": "Gera um novo par de tokens (acesso e refresh) usando um refresh token válido.\n"
          },
          "response": []
        }
      ],
      "description": "Antes de consumir qualquer recurso da API, é necessário obter um token de autenticação (gumgaToken).  \nEsse token deve ser incluído no header de todas as requisições subsequentes."
    },
    {
      "name": "Cadastros e Configuracoes",
      "item": [
        {
          "name": "Obtém lista dos marketplaces",
          "request": {
            "auth": {
              "type": "noauth"
            },
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gungaToken>",
                "description": "(Required) Token de autenticação."
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/channel/list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "channel",
                "list"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Busca os tipos de repasses  por marketplace",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gungaToken>",
                "description": "(Required) Token de autenticação.",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/releasetype/:channelName",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "releasetype",
                ":channelName"
              ],
              "variable": [
                {
                  "key": "channelName",
                  "value": "MERCADOLIVRE",
                  "description": "Nome do marketplace\n\n"
                }
              ]
            }
          },
          "response": []
        }
      ],
      "description": "⚙️ Esses endpoints fornecem informações de apoio, como a lista de marketplaces e os tipos de repasses disponíveis, facilitando parametrizações no ERP.\n\n📌 **Nota prática:**  \nOs endpoints de cadastros e configurações são usados principalmente na **fase inicial de integração do ERP** (parametrização de canais e mapeamento de tipos de repasse).  \nNo dia a dia das baixas, o uso é menos frequente, mas eles podem ser consultados em casos de auditoria, validação ou inclusão de novos marketplaces."
    },
    {
      "name": "Consulta Conciliacoes",
      "item": [
        {
          "name": "Obtém conciliações não resolvidas",
          "protocolProfileBehavior": {
            "disabledSystemHeaders": {}
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "(Required) Token de autenticação.",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/unresolveds?offset=1&limit=100&initDate=2026-01-01&endDate=2026-01-31&conciliationId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "unresolveds"
              ],
              "query": [
                {
                  "key": "offset",
                  "value": "1"
                },
                {
                  "key": "limit",
                  "value": "100"
                },
                {
                  "key": "initDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "endDate",
                  "value": "2026-01-31"
                },
                {
                  "key": "conciliationId",
                  "value": null
                },
                {
                  "key": "channelName",
                  "value": "",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "onlyUnread",
                  "value": "false",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "onlyAnalyzed",
                  "value": "true",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "dateTypeToFilter",
                  "value": "ORDER_DATE",
                  "type": "text",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "name": "Obtém conciliações resolvidas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "(Required) Token de autenticação.",
                "type": "text"
              },
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/concilieds?offset=1&limit=100&initDate=2026-01-01&endDate=2026-01-01&conciliationId&channelName",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "concilieds"
              ],
              "query": [
                {
                  "key": "offset",
                  "value": "1"
                },
                {
                  "key": "limit",
                  "value": "100"
                },
                {
                  "key": "initDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "endDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "conciliationId",
                  "value": null
                },
                {
                  "key": "channelName",
                  "value": null
                }
              ]
            }
          },
          "response": []
        }
      ],
      "description": "Esses endpoints permitem listar as conciliações geradas no Koncili, tanto as que ainda estão pendentes de resolução quanto as já resolvidas. São úteis para acompanhar o ciclo completo da conciliação."
    },
    {
      "name": "Segmentacao de IPs",
      "item": [
        {
          "name": "IPs que foram habilitados por token",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Habilita um IP",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ip\": \"ip\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Remove um IP que foi habilitado",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ip\": \"ip\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        }
      ],
      "description": " A API do Koncili possui um mecanismo adicional de **segurança baseado em IP**, garantindo que apenas endereços previamente autorizados possam realizar chamadas autenticadas.\n\nCada gumgaToken está vinculado a uma **lista de IPs liberados**, e somente esses endereços podem consumir os recursos do endpoint /externalapi/."
    },
    {
      "name": "Acoes em lote",
      "item": [
        {
          "name": "Atualiza repasses como resolvido em lote",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "(Required) Token de autenticação."
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "[0]\r\n",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/resolve/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "resolve",
                "batch"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Atualiza repasses como lido em lote",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "[0]",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/read/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "read",
                "batch"
              ]
            }
          },
          "response": []
        }
      ],
      "description": "endpoints permitem atualizar múltiplos repasses de uma só vez, tornando o processo mais ágil e escalável. São especialmente indicados para ERPs que processam grandes volumes de pedidos."
    }
  ],
  "variable": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "baseUrl",
      "value": "https://api.koncili.com"
    }
  ]
}