{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"82b1c4eb-7d8e-4493-9f96-7d8c7e254473","name":"Integração API GSafra","description":"---\n\ntitle: \"GSafra API: guia completo de integração para desenvolvedores\"  \nsidebarTitle: \"Introdução\"  \ndescription: \"Conheça a API GSafra e seus módulos de integração: Financeiro, Colheita, Contratos, Fiscal, Compras, Estoque, Vendas, Patrimônio e Atividades Agrícolas.\"\n\n---\n\nA **API GSafra** é uma interface REST que permite a integração de sistemas externos com a plataforma de gestão agrícola GSafra. Por meio dela, você pode consultar, consolidar e exportar dados operacionais e financeiros da sua empresa diretamente nos seus próprios sistemas — sejam ERPs, dashboards, aplicações mobile ou pipelines de dados. Com acesso programático a módulos que cobrem desde o financeiro até as atividades de campo, a API GSafra oferece a flexibilidade necessária para construir integrações robustas e adaptadas à realidade do agronegócio.\n\n## Módulos disponíveis\n\nA API GSafra está organizada em módulos temáticos, cada um expondo endpoints relacionados a uma área específica da gestão agrícola. Conheça os módulos disponíveis:\n\n| Módulo | Descrição |\n| --- | --- |\n| **Financeiro** | Consulte contas a receber, contas a pagar e movimentos financeiros registrados na plataforma. |\n| **Colheita** | Acesse os romaneios de colheita, com informações detalhadas sobre as cargas e volumes produzidos. |\n| **Contratos** | Recupere dados de contratos comerciais cadastrados no sistema, incluindo condições e partes envolvidas. |\n| **Docs Fiscais (NF-e)** | Consulte as notas fiscais eletrônicas emitidas e recebidas, com dados de chave de acesso, emitente e valores. |\n| **Descontos de Armazenamento** | Acesse os registros de descontos aplicados nas operações de armazenamento de grãos e insumos. |\n| **Talhão Safra** | Consulte informações sobre os talhões vinculados a cada safra, incluindo área, cultura e localização. |\n| **Compras** | Visualize os itens comprados registrados no sistema, com fornecedores, quantidades e valores. |\n| **Movimento de Estoque** | Acompanhe as movimentações de entrada e saída de produtos no estoque da fazenda. |\n| **LCDPR** | Acesse os dados do Livro Caixa Digital do Produtor Rural para fins de apuração e conformidade fiscal. |\n| **Vendas** | Consulte as vendas realizadas, com detalhes de produtos, clientes e condições comerciais. |\n| **Patrimônio** | Gerencie informações sobre patrimônios cadastrados, bem como seus registros de abastecimentos e manutenções. |\n| **Atividades Agrícolas** | Acesse o planejamento de atividades, as atividades realizadas e as atividades não planejadas executadas no campo. |\n\n## Características da API\n\nA API GSafra foi projetada com foco em simplicidade e segurança. Veja os principais aspectos técnicos que você precisa conhecer antes de começar a integrar:\n\n- **Arquitetura REST:** todos os recursos seguem os princípios REST, com endpoints semânticos e respostas em JSON.\n    \n- **Método GET exclusivo:** todos os endpoints da API utilizam o método HTTP `GET`. A API é voltada para consulta de dados.\n    \n- **Filtros por período:** a maioria dos endpoints aceita os parâmetros de query `startDate` e `endDate` no formato `DD-MM-YYYY` para delimitar o intervalo de datas da consulta.\n    \n- **Autenticação por API Key:** todas as requisições precisam incluir uma chave de API no header `x-api-key`. Não há sessões, cookies ou fluxo OAuth envolvido.\n    \n- **Prefixo de versão** **`/v1/`****:** todos os endpoints estão sob o prefixo `/v1/`, o que garante compatibilidade futura à medida que a API evolui.\n    \n- **Base URL configurável:** a URL base (`{{baseUrl}}`) é configurada por ambiente, facilitando o uso em cenários de desenvolvimento, homologação e produção.\n    \n\n  \n  \nA API GSafra é somente leitura. Nenhuma operação de escrita, atualização ou exclusão está disponível via API nesta versão.  \n  \n  \n\n## Próximos passos\n\nAgora que você conhece a API GSafra e seus módulos, é hora de colocar a mão na massa. Siga os guias abaixo para configurar sua autenticação e fazer sua primeira requisição.\n\n  \n  \n  \nSaiba como obter sua API Key e configurar o header \\`x-api-key\\` em todas as suas requisições.  \n  \n  \n  \nFaça sua primeira chamada à API GSafra em 4 passos simples e veja os dados retornados em tempo real.  \n  \n  \n  \nEntenda os conceitos fundamentais da API, como filtros de data, paginação e estrutura de resposta.  \n  \n  \n  \nExplore a referência completa de todos os endpoints disponíveis, organizados por módulo.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"58102257","team":41086787,"collectionId":"82b1c4eb-7d8e-4493-9f96-7d8c7e254473","publishedId":"2sBYB4Km9v","public":true,"publicUrl":"https://docs.gsafra.com","privateUrl":"https://go.postman.co/documentation/58102257-82b1c4eb-7d8e-4493-9f96-7d8c7e254473","customColor":{"top-bar":"FFFFFF","right-sidebar":"0A8C56","highlight":"0A8C56"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Documentação API GSafra"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"0A8C56","highlight":"0A8C56"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"0A8C56","highlight":"0A8C56"}}]}},"version":"8.12.7","publishDate":"2026-09-29T12:54:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação API GSafra","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8719c9cf87a1b5e7feab334fa8c9e20597446de9af663447e6acafb3b935420d","favicon":"https://gsafra.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.gsafra.com/view/metadata/2sBYB4Km9v"}