{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e8cb38a9-4044-44c2-bfec-d453681e757d","name":"API Bsoft TMS","description":"## **Documentação da API do Bsoft TMS**\n\nA documentação API Bsoft TMS traz toda a informação técnica necessária para que o desenvolvedor do sistema utilizado pela sua empresa faça a integração com a plataforma Bsoft TMS trazendo para você todos os benefícios de utilizar uma plataforma totalmente integrada com os sistemas utilizados na sua operação.\n\n**Informações sobre as credenciais de acesso**\n\nPara obter todas as Collections e Environments para você realizar a integração, basta clicar no botão **Run in Postman,** localizado no canto superior direito da página, e importar dentro do seu **postman**.  \nCom isso, você estará com o cenário pronto para realizar os testes de integração.\n\n### **Informações sobre as credenciais de acesso**\n\nAntes de começar, certifique-se de ter recebido as seguintes credenciais de acesso:\n\n\\- Nome do domínio (seudominio.bsoft.app)  \n\\- Nome do usuário (Esse usuário deverá ter o perfil de integração)  \n\\- Senha\n\n**Utilizando as credencias dentro do postman**\n\nApós receber essas informações, você pode alterar as variáveis de configurações dentro do Postman. _(Enviroments>Variable)_\n\nQuando você acessar as variáveis de ambiente do seu _postman_, após importar as collections e environments, você terá que alterar essas 3 variáveis, com base nas credenciais de acesso recebidas:\n\nO nome das variáveis são: dominio, usuario e senha\n\nA variável 'url' é utilizada nas URLs das requisições, com marcação, mas você não precisa alterá-la, pois ela já utiliza a variável 'dominio'.\n\nOBS: Não disponibilizamos área de homologação, todos os testes serão feitos diretamente na sua área de produção, então tenha cuidado ao realizar os testes.\n\n### **Filtro e paginação**\n\nNas requisições via GET que retorna uma lista de dados, você terá que realizar uma paginação e para isso você precisa informar um parâmetro na URL chamado \"limit\" contendo o intervalo desejado, exemplo.:  \n?limit=0,10 = trás os 10 primeiros registros  \n?limit=10,10 = também traz 10 registros, mas retorna a partir do décimo registro\n\nAlém disso você pode consultar um registro específico diretamente passando seu identificador na URL:  \nExemplo: .../pessoa/147  \nNesse exemplo você estará obtendo os dados da pessoa com código 147.\n\nOs campos de data, informados como parâmetros nas requisições via GET, têm que ser informados no formato (Y-m-d).\n\n### **Informações de Suporte**\n\nPara suporte durante o processo de homologação da integração utilizar os seguintes canais:  \nE-mail: [suporte.tms@bsoft.com.br](https://mailto:suporte.tms@bsoft.com.br)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20889534","team":3444588,"collectionId":"e8cb38a9-4044-44c2-bfec-d453681e757d","publishedId":"2sB2cbbJw8","public":true,"publicUrl":"https://docs.bsoft.app","privateUrl":"https://go.postman.co/documentation/20889534-e8cb38a9-4044-44c2-bfec-d453681e757d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-04-27T14:42:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"API Bsoft TMS","id":"6bf4ddbe-ea27-4797-92a6-484c3df01263","owner":"20889534","values":[{"key":"dominio","value":"seudominio.bsoft.app","enabled":true,"type":"default"},{"key":"usuario","value":"","enabled":true,"type":"default"},{"key":"senha","value":"","enabled":true,"type":"secret"},{"key":"url","value":"https://{{dominio}}/services/index.php","enabled":true,"type":"default"}],"published":true}],"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/60378759c461664636ca11614ba930377a590beb989ac42b4ee3eddd1d27e455","favicon":"https://res.cloudinary.com/postman/image/upload/v1750187520/team/7620f10ec1b7287a7e600a66d30bf69c.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"},{"label":"API Bsoft TMS","value":"20889534-6bf4ddbe-ea27-4797-92a6-484c3df01263"}],"canonicalUrl":"https://docs.bsoft.app/view/metadata/2sB2cbbJw8"}